Indexes

Get Index

Get an index by ID.

get/api/v1/indexes/{index_id}

Request

Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
URL: https://api.cloud.llamaindex.ai/api/v1/indexes/{index_id}
Auth: HTTP bearer

index_idstring required

expandstring[]

Fields to expand. Supported value: sync_in_progress.

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.

output_directory_idstring required

ID of the output directory holding the indexed files.

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.

sync_in_progressboolean nullable

Whether the index is syncing its source or exporting the result. Requires expand=sync_in_progress.

metadataIndexMetadata

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

Oct 16, 2026a38b684f8e1b Revision changes
- info
  added the new optional query request parameter expand
- info
  added the optional property // to the response with the status
- info
  added the optional property // to the response with the status
- info
  added the optional property to the response with the status
- info
  added the required property to the response with the status
Jun 9, 2026614771991b52 Revision changes
- warning
  removed the optional property // from the response with the status
- warning
  removed the optional property // from the response with the status