Skip to main content
POST
/
v1
/
artifacts
/
delete
/
async
Delete Document Asynchronously
curl --request POST \
  --url https://{base_url}/gpt/v1/artifacts/delete/async \
  --header 'Content-Type: application/json' \
  --data '
{
  "delete_body": {
    "collection": "financial_reports",
    "artifact": "obsolete_report_2022"
  }
}
'
{
  "task_id": "<string>"
}

Body

application/json

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

Request body for asynchronous document deletion.

delete_body
DeleteIngestedDocumentBody · object
required

Document deletion parameters including collection and artifact identifiers

Examples:
{
  "artifact": "q2_2023_report",
  "collection": "financial_reports"
}
{
  "artifact": "outdated_policy_manual",
  "collection": "hr_documents"
}
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 deletion 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"