Add a document
Add content to a knowledge base from a file upload or a URL.
file or a source_url, not both. The response is 202 - ingestion runs in the
background. Poll Get a knowledge base until the document’s
status reads processed; a failed document carries an error_message.Authorizations
Your API key as a Bearer token, e.g. Authorization: Bearer vk_….
Path Parameters
The knowledge base's id, from POST/GET /v1/knowledge-bases.
Body
Response
Accepted — the document is queued for processing. Poll the knowledge base until its status reads processed.
One piece of content in a knowledge base, as the public API promises it.
status is the ingestion state — adding a document returns 202 and processing happens in the
background, so a client polls the KB until this reads processed.
The document's id.
The name we stored it under.
Where it was fetched from, for a URL-sourced document.
What kind of file it is.
Where ingestion got to — pending, processing, processed, or failed. Ingestion is asynchronous: the upload returns 202 and the document is not searchable until this reads processed. On failed, error_message says why.
Why ingestion failed, if it did.
When it was uploaded (UTC, ISO 8601).
When its status last changed (UTC, ISO 8601).