Skip to content
  • Auto
  • Light
  • Dark

Retrieve

Retrieve Status of Indexing Job for a Knowledge Base
get/v2/gen-ai/indexing_jobs/{uuid}

To get status of an indexing Job for a knowledge base, send a GET request to /v2/gen-ai/indexing_jobs/{uuid}.

Path Parameters
uuidstring
Returns
jobcompleted_datasourcesnumbercreated_atstringdata_source_uuidsarray of stringfinished_atstringknowledge_base_uuidstringphaseenumstarted_atstringstatusenumtokensnumbertotal_datasourcesnumberupdated_atstringuuidstringAPIIndexingJob
optional

IndexingJob description

curl https://api.digitalocean.com//v2/gen-ai/indexing_jobs/$UUID \
    -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\""
  }
}