API reference
26 endpoints, generated from the OpenAPI contract the hosted API serves. Each page lists parameters, request and response fields, and Python, JavaScript and cURL samples.
This reference covers the endpoints an API key can call. The deployed service also serves routes for the web app, account administration and the platform itself; those need a signed-in session or an operator key and are left out on purpose. See API keys and permissions.
Collections
Collections your key can see. Collections are created in the app.
Documents
Add documents, follow their processing, and remove them.
- POST
/v1/{knowledge_id}/upload-urlGet an upload URL - GET
/v1/{knowledge_id}/documentsList documents - POST
/v1/{knowledge_id}/documentsAdd a document - GET
/v2/{knowledge_id}/documentsList documents (paginated) - DELETE
/v1/{knowledge_id}/documents/{object_id}Delete a document - GET
/v1/{knowledge_id}/documents/{object_id}/statusGet a document's processing status - GET
/v1/{knowledge_id}/documents/{object_id}/deletion-statusGet a document's deletion status - POST
/v1/{knowledge_id}/documents/summariesGet document summaries
Batch upload
Add up to 50 documents in one call.
Search
Find the passages that match a query.
Chat
Ask questions answered from the collection, with cited sources.
Extracted fields
The fields read out of every document, per document or as a table.
- GET
/v1/{knowledge_id}/documents/{object_id}/metadataGet a document's extracted fields - POST
/v1/{knowledge_id}/documents/metadata/allGet every document's fields as a table (cursor pages) - POST
/v2/{knowledge_id}/documents/metadata/allGet every document's fields as a table - GET
/v1/{knowledge_id}/enrichmentGet the field definitions
Sections
The indexed sections (chunks) a document was split into.
Service
Service status.