API Reference
Ingestion API
REST API endpoints for pushing data into your knowledge base.
POST /ingest
Ingest a single item into your knowledge base.
Headers:
x-api-key— API key withiq:importscopeContent-Type: application/json
Request Body:
{
"integrationId": "string",
"knowledgeBaseId": "string",
"sourceType": "PRODUCT | ARTICLE | PAGE | SERVICE | PERSON",
"externalId": "string",
"data": {
"title": "string",
"content": "string",
"url": "string (optional)",
"sourceData": "object (optional)",
"hash": "string (optional)"
},
"options": {
"forceRefresh": "boolean (optional)",
"priority": "high | low (optional)"
}
}Response (200):
{
"status": "queued",
"jobId": "integration-id-external-id"
}POST /ingest/bulk
Ingest multiple items in a single request.
Request Body:
{
"items": [ /* array of ingestion items */ ]
}Response (200):
{
"status": "queued",
"jobCount": 50,
"estimatedTime": "5s",
"jobIds": ["id-1", "id-2"]
}