Skip to content
Developer Documentation
API Reference
Beta

Indexes

Get Index
beta.indexes.get(strindex_id, IndexGetParams**kwargs) -> IndexGetResponse
GET/api/v1/indexes/{index_id}
Delete Index
beta.indexes.delete(strindex_id, IndexDeleteParams**kwargs)
DELETE/api/v1/indexes/{index_id}
Create Index
beta.indexes.create(IndexCreateParams**kwargs) -> IndexCreateResponse
POST/api/v1/indexes
Sync Index
beta.indexes.sync(strindex_id, IndexSyncParams**kwargs) -> object
POST/api/v1/indexes/{index_id}/sync
List Indexes
beta.indexes.list(IndexListParams**kwargs) -> SyncPaginatedCursor[IndexListResponse]
GET/api/v1/indexes
ModelsExpand Collapse
class IndexGetResponse: …

A searchable index over a directory of documents.

id: str

Unique identifier

export_config_id: str

ID of the export configuration.

name: str

Index name.

output_directory_id: str

ID of the output directory holding the indexed files.

project_id: str

Project this index belongs to.

source_directory_id: str

ID of the source directory.

sync_config_id: str

ID of the sync configuration.

created_at: Optional[datetime]

Creation datetime

formatdate-time
description: Optional[str]

Index description.

last_exported_at: Optional[datetime]

Last export time.

formatdate-time
last_synced_at: Optional[datetime]

Last sync time.

formatdate-time
metadata: Optional[Dict[str, object]]

Build state and diagnostic info.

updated_at: Optional[datetime]

Update datetime

formatdate-time
class IndexCreateResponse: …

A searchable index over a directory of documents.

id: str

Unique identifier

export_config_id: str

ID of the export configuration.

name: str

Index name.

output_directory_id: str

ID of the output directory holding the indexed files.

project_id: str

Project this index belongs to.

source_directory_id: str

ID of the source directory.

sync_config_id: str

ID of the sync configuration.

created_at: Optional[datetime]

Creation datetime

formatdate-time
description: Optional[str]

Index description.

last_exported_at: Optional[datetime]

Last export time.

formatdate-time
last_synced_at: Optional[datetime]

Last sync time.

formatdate-time
metadata: Optional[Dict[str, object]]

Build state and diagnostic info.

updated_at: Optional[datetime]

Update datetime

formatdate-time
class IndexListResponse: …

A searchable index over a directory of documents.

id: str

Unique identifier

export_config_id: str

ID of the export configuration.

name: str

Index name.

output_directory_id: str

ID of the output directory holding the indexed files.

project_id: str

Project this index belongs to.

source_directory_id: str

ID of the source directory.

sync_config_id: str

ID of the sync configuration.

created_at: Optional[datetime]

Creation datetime

formatdate-time
description: Optional[str]

Index description.

last_exported_at: Optional[datetime]

Last export time.

formatdate-time
last_synced_at: Optional[datetime]

Last sync time.

formatdate-time
metadata: Optional[Dict[str, object]]

Build state and diagnostic info.

updated_at: Optional[datetime]

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/