Skip to content
DigitalOcean Gradient™ AI Agentic Cloud SDK Docs
  • Auto
  • Light
  • Dark

Indexing Jobs

API Reference
Knowledge Bases

Indexing Jobs

Start Indexing Job for a Knowledge Base
post/v2/gen-ai/indexing_jobs
List Indexing Jobs for a Knowledge Base
get/v2/gen-ai/indexing_jobs
Retrieve Status of Indexing Job for a Knowledge Base
get/v2/gen-ai/indexing_jobs/{uuid}
List Data Sources for Indexing Job for a Knowledge Base
get/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources
Cancel Indexing Job for a Knowledge Base
put/v2/gen-ai/indexing_jobs/{uuid}/cancel
ModelsExpand Collapse
APIIndexedDataSource = object { completed_at, data_source_uuid, error_details, 11 more }
completed_at: optional string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid: optional string

Uuid of the indexed data source

error_details: optional string

A detailed error description

error_msg: optional string

A string code provinding a hint which part of the system experienced an error

failed_item_count: optional string

Total count of files that have failed

formatuint64
indexed_file_count: optional string

Total count of files that have been indexed

formatuint64
indexed_item_count: optional string

Total count of files that have been indexed

formatuint64
removed_item_count: optional string

Total count of files that have been removed

formatuint64
skipped_item_count: optional string

Total count of files that have been skipped

formatuint64
started_at: optional string

Timestamp when data source started indexing

formatdate-time
status: optional "DATA_SOURCE_STATUS_UNKNOWN" or "DATA_SOURCE_STATUS_IN_PROGRESS" or "DATA_SOURCE_STATUS_UPDATED" or 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes: optional string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed: optional string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count: optional string

Total file count in the data source

formatuint64
APIIndexingJob = object { completed_datasources, created_at, data_source_jobs, 16 more }

IndexingJob description

completed_datasources: optional number

Number of datasources indexed completed

formatint64
created_at: optional string

Creation date / time

formatdate-time
data_source_jobs: optional array of APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more }

Details on Data Sources included in the Indexing Job

completed_at: optional string

Timestamp when data source completed indexing

formatdate-time
data_source_uuid: optional string

Uuid of the indexed data source

error_details: optional string

A detailed error description

error_msg: optional string

A string code provinding a hint which part of the system experienced an error

failed_item_count: optional string

Total count of files that have failed

formatuint64
indexed_file_count: optional string

Total count of files that have been indexed

formatuint64
indexed_item_count: optional string

Total count of files that have been indexed

formatuint64
removed_item_count: optional string

Total count of files that have been removed

formatuint64
skipped_item_count: optional string

Total count of files that have been skipped

formatuint64
started_at: optional string

Timestamp when data source started indexing

formatdate-time
status: optional "DATA_SOURCE_STATUS_UNKNOWN" or "DATA_SOURCE_STATUS_IN_PROGRESS" or "DATA_SOURCE_STATUS_UPDATED" or 4 more
Accepts one of the following:
"DATA_SOURCE_STATUS_UNKNOWN"
"DATA_SOURCE_STATUS_IN_PROGRESS"
"DATA_SOURCE_STATUS_UPDATED"
"DATA_SOURCE_STATUS_PARTIALLY_UPDATED"
"DATA_SOURCE_STATUS_NOT_UPDATED"
"DATA_SOURCE_STATUS_FAILED"
"DATA_SOURCE_STATUS_CANCELLED"
total_bytes: optional string

Total size of files in data source in bytes

formatuint64
total_bytes_indexed: optional string

Total size of files in data source in bytes that have been indexed

formatuint64
total_file_count: optional string

Total file count in the data source

formatuint64
data_source_uuids: optional array of string
finished_at: optional string
formatdate-time
is_report_available: optional boolean

Boolean value to determine if the indexing job details are available

knowledge_base_uuid: optional string

Knowledge base id

phase: optional "BATCH_JOB_PHASE_UNKNOWN" or "BATCH_JOB_PHASE_PENDING" or "BATCH_JOB_PHASE_RUNNING" or 4 more
Accepts one of the following:
"BATCH_JOB_PHASE_UNKNOWN"
"BATCH_JOB_PHASE_PENDING"
"BATCH_JOB_PHASE_RUNNING"
"BATCH_JOB_PHASE_SUCCEEDED"
"BATCH_JOB_PHASE_FAILED"
"BATCH_JOB_PHASE_ERROR"
"BATCH_JOB_PHASE_CANCELLED"
started_at: optional string
formatdate-time
status: optional "INDEX_JOB_STATUS_UNKNOWN" or "INDEX_JOB_STATUS_PARTIAL" or "INDEX_JOB_STATUS_IN_PROGRESS" or 4 more
Accepts one of the following:
"INDEX_JOB_STATUS_UNKNOWN"
"INDEX_JOB_STATUS_PARTIAL"
"INDEX_JOB_STATUS_IN_PROGRESS"
"INDEX_JOB_STATUS_COMPLETED"
"INDEX_JOB_STATUS_FAILED"
"INDEX_JOB_STATUS_NO_CHANGES"
"INDEX_JOB_STATUS_PENDING"
tokens: optional number

Number of tokens [This field is deprecated]

formatint64
total_datasources: optional number

Number of datasources being indexed

formatint64
total_items_failed: optional string

Total Items Failed

formatuint64
total_items_indexed: optional string

Total Items Indexed

formatuint64
total_items_removed: optional string

Total Items Removed

formatuint64
total_items_skipped: optional string

Total Items Skipped

formatuint64
total_tokens: optional string

Total Tokens Consumed By the Indexing Job

formatuint64
updated_at: optional string

Last modified

formatdate-time
uuid: optional string

Unique id