Skip to main content
POST
/
v1
/
artifacts
/
ingest
/
async
curl --request POST \ --url https://{base_url}/gpt/v1/artifacts/ingest/async \ --header 'Content-Type: application/json' \ --data ' { "ingest_body": { "input": { "type": "file", "value": "JVBERi0xLjQKJaqrrK0KMS..." }, "artifact": "quarterly_report", "collection": "financial_docs", "metadata": { "file_name": "Q3_Report.pdf" } } } '
{
  "task_id": "123e4567-e89b-12d3-a456-426614174000"
}

Body

application/json

JSON request body containing ingestion parameters and callback configuration for asynchronous processing notifications

Request body for asynchronous URI ingestion.

​
ingest_body
IngestBody · object
required

Document ingestion parameters including artifact, collection, input data, and optional metadata

Examples:
{
  "artifact": "company_mission_statement",
  "collection": "corporate_docs",
  "input": {
    "type": "text",
    "value": "Our mission is to democratize access to artificial intelligence through secure, private, and user-controlled AI systems that respect data sovereignty and privacy."
  },
  "metadata": {
    "author": "CEO",
    "created_date": "2024-01-01",
    "department": "Executive",
    "file_name": "mission_statement.txt"
  }
}

{
  "artifact": "product_description",
  "collection": "marketing_materials",
  "input": {
    "type": "uri",
    "value": "https://cdn.example.com/reports/annual-2023.pdf"
  },
  "metadata": {
    "file_name": "product_desc.txt",
    "target_audience": "enterprise",
    "version": "1.0"
  }
}

{
  "artifact": "user_manual_chapter_1",
  "collection": "user_manuals",
  "input": {
    "type": "file",
    "value": "UEsDBBQABgAIAAAAIQDf3k5bAAAACgAAAHN0cmluZy50eHRVVQ=="
  },
  "metadata": {
    "author": "Jane Smith",
    "created_date": "2024-02-01",
    "file_name": "chapter_1.txt"
  }
}
​
callback
Callback · object

Optional callback configuration for receiving asynchronous task notifications

Example:
{
  "amqp": {
    "exchange": "ingest",
    "routing_key_done": "ingest.done",
    "routing_key_error": "ingest.error"
  },
  "properties": { "key": "value" }
}

Response

Successfully initiated ingestion task

Represents an asynchronous task that has been queued.

​
task_id
string
required

Unique identifier for the asynchronous task, used to track progress and retrieve results

Examples:

"123e4567-e89b-12d3-a456-426614174000"

"revoked"