v34

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-09194386949.7 KB

Indexes

Get Index

Get an index by ID.

get/api/v1/indexes/{index_id}

index_idstring required

project_idstring uuid nullable

organization_idstring uuid nullable

sessionstring nullable

Successful Response

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

namestring required

Index name.

descriptionstring nullable

Index description.

project_idstring required

Project this index belongs to.

source_directory_idstring required

ID of the source directory.

sync_config_idstring required

ID of the sync configuration.

export_config_idstring required

ID of the export configuration.

last_synced_atstring date-time nullable

Last sync time.

last_exported_atstring date-time nullable

Last export time.

metadataIndexMetadata

Build state and diagnostic info about an index. Schema is open; only status of ready or failed is stable.