List knowledge base items
Lists items (ingested documents) of a knowledge base, most recently uploaded first by default.
Organization or project Access Key created in the Dynamiq console. Used for deployed-app (Runs API), AI Gateway, traces collector, and management API requests. Send as Authorization: Bearer <access-key>.
In: header
Path Parameters
Knowledge base UUID.
Query Parameters
Filter by processing status.
Filter by knowledge base source UUID.
Page number (1-based).
Number of items per page.
Comma-separated sort fields. Prefix a field with - for descending order, e.g. sort=-started_at.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/knowledgebases/497f6eca-6276-4993-bfeb-53cbbbba6f08/items"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"knowledgebase_id": "6f950f69-320f-4b35-bbd4-0a7c1c91d2a1",
"status": "pending",
"uploaded_at": "2019-08-24T14:15:22Z",
"name": "string",
"metadata": {},
"source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
"source_item_id": "ecd67d68-17cf-49d7-bd46-c75899862e20",
"trace_id": "df570c03-5a03-4cea-8df0-c162d05127ac",
"task_id": "736fde4d-9029-4915-8189-01353d6982cb",
"source": {},
"source_item": {}
}
],
"pagination": {
"page": 0,
"page_size": 0,
"page_count": 0,
"total_count": 0
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}Upload documents to a knowledge base
Uploads one or more files for ingestion. Optional per-file metadata is passed in the `input` form field as a JSON object whose `metadata` array must match the number of files. To replace existing items in place, pass their item IDs in the `ids` form field (JSON array, same length as `files`). The maximum request size is 128 MiB. Items are processed asynchronously; poll the items endpoints for status.
Get a knowledge base item
Returns a single knowledge base item.