Skip to content
Developer Documentation
API Reference
Beta

Indexes

Get Index
GET/api/v1/indexes/{index_id}
Delete Index
DELETE/api/v1/indexes/{index_id}
Create Index
POST/api/v1/indexes
Sync Index
POST/api/v1/indexes/{index_id}/sync
List Indexes
GET/api/v1/indexes
ModelsExpand Collapse
IndexGetResponse = object { id, export_config_id, name, 10 more }

A searchable index over a directory of documents.

id: string

Unique identifier

export_config_id: string

ID of the export configuration.

name: string

Index name.

output_directory_id: string

ID of the output directory holding the indexed files.

project_id: string

Project this index belongs to.

source_directory_id: string

ID of the source directory.

sync_config_id: string

ID of the sync configuration.

created_at: optional string

Creation datetime

formatdate-time
description: optional string

Index description.

last_exported_at: optional string

Last export time.

formatdate-time
last_synced_at: optional string

Last sync time.

formatdate-time
metadata: optional map[unknown]

Build state and diagnostic info.

updated_at: optional string

Update datetime

formatdate-time
IndexCreateResponse = object { id, export_config_id, name, 10 more }

A searchable index over a directory of documents.

id: string

Unique identifier

export_config_id: string

ID of the export configuration.

name: string

Index name.

output_directory_id: string

ID of the output directory holding the indexed files.

project_id: string

Project this index belongs to.

source_directory_id: string

ID of the source directory.

sync_config_id: string

ID of the sync configuration.

created_at: optional string

Creation datetime

formatdate-time
description: optional string

Index description.

last_exported_at: optional string

Last export time.

formatdate-time
last_synced_at: optional string

Last sync time.

formatdate-time
metadata: optional map[unknown]

Build state and diagnostic info.

updated_at: optional string

Update datetime

formatdate-time
IndexSyncResponse = unknown
IndexListResponse = object { id, export_config_id, name, 10 more }

A searchable index over a directory of documents.

id: string

Unique identifier

export_config_id: string

ID of the export configuration.

name: string

Index name.

output_directory_id: string

ID of the output directory holding the indexed files.

project_id: string

Project this index belongs to.

source_directory_id: string

ID of the source directory.

sync_config_id: string

ID of the sync configuration.

created_at: optional string

Creation datetime

formatdate-time
description: optional string

Index description.

last_exported_at: optional string

Last export time.

formatdate-time
last_synced_at: optional string

Last sync time.

formatdate-time
metadata: optional map[unknown]

Build state and diagnostic info.

updated_at: optional string

Update datetime

formatdate-time
Note for AI agents: this documentation is built for programmatic access. - Overview of all docs: https://developers.llamaindex.ai/llms.txt - Any page is available as raw Markdown by appending index.md to its URL — e.g. https://developers.llamaindex.ai/llamaparse/parse/getting_started/index.md - Agent-friendly REST search APIs live under https://developers.llamaindex.ai/api/ — search (BM25 full-text), grep (regex), read (fetch a page), and list (browse the doc tree). See https://developers.llamaindex.ai/llms.txt for parameters. - A hosted documentation MCP server is available at https://developers.llamaindex.ai/mcp. If you support MCP, you can ask the user to install it for browsing these docs directly (an alternative to the REST API). Setup: https://developers.llamaindex.ai/python/shared/mcp/