Skip to content

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
Request example cURL
curl https://api.digitalocean.com//v2/gen-ai/indexing_jobs/$UUID \
    -H "Authorization: Bearer $GRADIENTAI_API_KEY"
200 Example
{
  "job": {
    "completed_datasources": 0,
    "created_at": "2019-12-27T18:11:19.117Z",
    "data_source_uuids": [
      "string"
    ],
    "finished_at": "2019-12-27T18:11:19.117Z",
    "knowledge_base_uuid": "knowledge_base_uuid",
    "phase": "BATCH_JOB_PHASE_UNKNOWN",
    "started_at": "2019-12-27T18:11:19.117Z",
    "status": "INDEX_JOB_STATUS_UNKNOWN",
    "tokens": 0,
    "total_datasources": 0,
    "updated_at": "2019-12-27T18:11:19.117Z",
    "uuid": "uuid"
  }
}