Indexing Jobs

API Reference

Knowledge Bases

Indexing Jobs

Start Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.create(IndexingJobCreateParams { data_source_uuids, knowledge_base_uuid } body?, RequestOptionsoptions?): IndexingJobCreateResponse { job }

post/v2/gen-ai/indexing_jobs

List Indexing Jobs for a Knowledge Base

client.knowledgeBases.indexingJobs.list(IndexingJobListParams { page, per_page } query?, RequestOptionsoptions?): IndexingJobListResponse { jobs, links, meta }

get/v2/gen-ai/indexing_jobs

Retrieve Status of Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.retrieve(stringuuid, RequestOptionsoptions?): IndexingJobRetrieveResponse { job }

get/v2/gen-ai/indexing_jobs/{uuid}

List Data Sources for Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.retrieveDataSources(stringindexingJobUuid, RequestOptionsoptions?): IndexingJobRetrieveDataSourcesResponse { indexed_data_sources }

get/v2/gen-ai/indexing_jobs/{indexing_job_uuid}/data_sources

Cancel Indexing Job for a Knowledge Base

client.knowledgeBases.indexingJobs.updateCancel(stringpathUuid, IndexingJobUpdateCancelParams { body_uuid } body?, RequestOptionsoptions?): IndexingJobUpdateCancelResponse { job }

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

ModelsExpand Collapse

APIIndexedDataSource { completed_at, data_source_uuid, error_details, 11 more }

completed_at?: string

Timestamp when data source completed indexing

formatdate-time

data_source_uuid?: string

Uuid of the indexed data source

error_details?: string

A detailed error description

error_msg?: string

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

failed_item_count?: string

Total count of files that have failed

formatuint64

indexed_file_count?: string

Total count of files that have been indexed

formatuint64

indexed_item_count?: string

Total count of files that have been indexed

formatuint64

removed_item_count?: string

Total count of files that have been removed

formatuint64

skipped_item_count?: string

Total count of files that have been skipped

formatuint64

started_at?: string

Timestamp when data source started indexing

formatdate-time

status?: "DATA_SOURCE_STATUS_UNKNOWN" | "DATA_SOURCE_STATUS_IN_PROGRESS" | "DATA_SOURCE_STATUS_UPDATED" | 3 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"

total_bytes?: string

Total size of files in data source in bytes

formatuint64

total_bytes_indexed?: string

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

formatuint64

total_file_count?: string

Total file count in the data source

formatuint64

APIIndexingJob { completed_datasources, created_at, data_source_uuids, 12 more }

IndexingJob description

completed_datasources?: number

Number of datasources indexed completed

formatint64

created_at?: string

Creation date / time

formatdate-time

data_source_uuids?: Array<string>

finished_at?: string

knowledge_base_uuid?: string

Knowledge base id

phase?: "BATCH_JOB_PHASE_UNKNOWN" | "BATCH_JOB_PHASE_PENDING" | "BATCH_JOB_PHASE_RUNNING" | 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?: string

status?: "INDEX_JOB_STATUS_UNKNOWN" | "INDEX_JOB_STATUS_PARTIAL" | "INDEX_JOB_STATUS_IN_PROGRESS" | 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?: number

Number of tokens

formatint64

total_datasources?: number

Number of datasources being indexed

formatint64

total_items_failed?: string

Total Items Failed

formatuint64

total_items_indexed?: string

Total Items Indexed

formatuint64

total_items_skipped?: string

Total Items Skipped

formatuint64

updated_at?: string

Last modified

formatdate-time

uuid?: string

Unique id