For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Contact usJoin the Discord
ManualAPI GuideAPI Reference
  • Overview
    • API Reference
    • Client libraries
  • API Reference
      • POSTIngest Content
      • POSTIngest Content Asynchronously
      • GETCheck Ingestion Task Status
      • GETList Ingested Documents
      • POSTDelete Ingested Document
      • POSTDelete Document Asynchronously
      • GETCheck Deletion Task Status
      • POSTRetrieve Full Document Content
      • POSTRetrieve Full Document Content in Chunks
LogoLogo
Contact usJoin the Discord
API ReferenceArtifacts

Ingest Content Asynchronously

POST
https://host.com/v1/artifacts/ingest/async
POST
/v1/artifacts/ingest/async
$curl -X POST https://host.com/v1/artifacts/ingest/async \
> -H "Content-Type: application/json" \
> -d '{
> "ingest_body": {
> "artifact": "string",
> "input": {
> "type": "file",
> "value": "string"
> }
> }
>}'
1{
2 "task_id": "string"
3}
Initiate asynchronous ingestion of content from multiple sources
Was this page helpful?
Previous

Check Ingestion Task Status

Next
Built with

Request

This endpoint expects an object.
ingest_bodyobjectRequired
Document ingestion parameters including artifact, collection, input data, and optional metadata
callbackobjectOptional
Optional callback configuration for receiving asynchronous task notifications

Response

This endpoint returns an object.
task_idstring
Unique identifier for the asynchronous task, used to track progress and retrieve results

Errors

401
Unauthorized
404
Not Found
422
Unprocessable Entity