Update Cancel

Cancel Indexing Job for a Knowledge Base

put/v2/gen-ai/indexing_jobs/{uuid}/cancel

To cancel an indexing job for a knowledge base, send a PUT request to /v2/gen-ai/indexing_jobs/{uuid}/cancel.

Path Parameters

uuidstring

Body Parameters

uuidstring

optional

A unique identifier for an indexing job.

Returns

jobcompleted_datasourcesnumbercreated_atstringdata_source_uuidsarray of stringfinished_atstringknowledge_base_uuidstringphaseenumstarted_atstringstatusenumtokensnumbertotal_datasourcesnumberupdated_atstringuuidstringAPIIndexingJob

optional

IndexingJob description

HTTPPython

curl https://api.digitalocean.com//v2/gen-ai/indexing_jobs/$UUID/cancel \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"

200 Example

{
  "job": {
    "completed_datasources": 123,
    "created_at": "2023-01-01T00:00:00Z",
    "data_source_uuids": [
      "example string"
    ],
    "finished_at": "2023-01-01T00:00:00Z",
    "knowledge_base_uuid": "\"123e4567-e89b-12d3-a456-426614174000\"",
    "phase": "BATCH_JOB_PHASE_UNKNOWN",
    "started_at": "2023-01-01T00:00:00Z",
    "status": "INDEX_JOB_STATUS_UNKNOWN",
    "tokens": 123,
    "total_datasources": 123,
    "updated_at": "2023-01-01T00:00:00Z",
    "uuid": "\"123e4567-e89b-12d3-a456-426614174000\""
  }
}