Content Import

Create Import Job

POST
/knowledge/contentmgr/v4/import/content

Import Content

Overview

This API initiates a bulk content import operation from Data Sources. It creates an asynchronous import job that processes content in the background, allowing you to import large volumes of content without blocking your application.

Pre-requisties

  1. Content in Data Source needs to be in this format: Guide to Data Import Format

How It Works

  1. Job Creation: The API creates an import job and returns a unique job ID
  2. Content Processing: Content is processed asynchronously in the background
  3. Status Monitoring: Use the job ID to monitor progress via the Status API
  4. Completion: Job completes when all content is processed or errors occur

Note: After a successful import, please allow for a brief delay before the content is fully available for use. The system's search service synchronizes all new and updated content every 30 minutes.

Supported Operations

  • Import: Add new content to the knowledge base
  • Update: Modify existing content

Data Source Types

  • AWS S3 bucket
  • Shared file path

Best Practices

  • Scheduling: Use scheduleTime for off-peak imports to minimize system impact. Please note that jobs can only be scheduled for a maximum of 7 days from the current date and time.
  • Monitoring: Regularly check job status and logs for any issues
  • Error Handling: Review failed items and retry with corrections

Job Timing Controls

  • scheduleTime.stopDate: Defines a specific date time to cease operations regardless of progress (e.g., "Stop exactly at 5:00 PM").

Authorization

accessToken
AuthorizationBearer <token>

JWT Bearer Token authentication for API access

In: header

Request Body

application/json

dataSource*
operation*string

Value in

  • "import"
  • "reimport"
scheduleTime?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/knowledge/contentmgr/v4/import/content" \  -H "Content-Type: application/json" \  -d '{    "dataSource": {      "type": "AWS S3 bucket",      "path": "s3://mybucket/myfolder/",      "region": "us-east-1",      "credentials": {        "accessKeyId": "AKIAIOSFODNN7EXAMPLE",        "secretAccessKey": "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY"      }    },    "operation": "import",    "scheduleTime": {      "date": "2024-03-01T10:00:00.000Z",      "stopDate": "2024-03-05T10:00:00.000Z"    }  }'
Empty