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
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.

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.

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