Ingestion API Overview

Introduction

Welcome to the eGain Ingestion API guide. This set of APIs provides a powerful and programmatic way to bulk-import, validate, and manage your knowledge content within the eGain AI Knowledge Hub. It is designed to handle large volumes of content from external sources, making it the ideal solution for migrations and automated content synchronization.

The entire process is asynchronous, which means that when you submit a request to import or validate content, the API creates a background job to handle the processing. This allows you to manage large datasets without blocking your applications and provides a robust way to track the job's progress through to completion.

What is the Ingestion API for?

The primary purpose of the Ingestion API is to streamline the process of getting your external content into eGain Knowledge. Whether you are moving from a different system or have an existing content repository you need to sync, these APIs provide the necessary tools to automate the workflow.

Common Use Cases

  • Legacy System Migration : Migrating thousands of articles from a legacy knowledge management system into the eGain platform.
  • Automated Content Updates : Setting up a recurring job to pull the latest product documentation from a content repository and update the knowledge base automatically.
  • Third-Party Content Integration : Regularly importing content feeds from external providers or different business units.
  • Pre-Production Validation : Integrating the validation API into your content creation pipeline to perform automated quality assurance checks before content is published.

The Ingestion Workflow

A typical end-to-end process for using the Ingestion API follows these steps:

  1. Format Your Content : Before you can import anything, your content must be structured in a specific way. This involves organizing your files into a defined folder structure and creating manifest files ( manifest.json , articles.json , knowledge.json ).
  2. Upload Your Data : Place your fully formatted and zipped content package into your chosen data source, which can be an AWS S3 bucket or an accessible Shared File Path (like SFTP).
  3. Validate the Content (Recommended) : Before running the actual import, it is highly recommended to run a validation job. This "dry run" checks your package for formatting errors, broken links, and other potential issues without writing any data to the knowledge base.
  4. Start the Import Job : Once you have uploaded your data (and preferably validated it), you can initiate the import job. You will choose the API endpoint that corresponds to your data source.
  5. Monitor the Job Status : After starting a validation or import job, the API immediately returns a job_id . You must use this ID to periodically check the status of the job until it is complete. The status endpoint will provide real-time progress, and upon completion, a summary of results, including any errors or warnings.

API Guides and Resources

To get started, please refer to the detailed guides below for step-by-step instructions and cURL examples.