API Reference

Beta

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Indexes

Get Index

client.beta.indexes.get(stringindexID, IndexGetParams { organization_id, project_id } query?, RequestOptionsoptions?): IndexGetResponse { id, export_config_id, name, 10 more }

GET/api/v1/indexes/{index_id}

Delete Index

client.beta.indexes.delete(stringindexID, IndexDeleteParams { organization_id, project_id } params?, RequestOptionsoptions?): void

DELETE/api/v1/indexes/{index_id}

Create Index

client.beta.indexes.create(IndexCreateParams { source_directory_id, organization_id, project_id, 6 more } params, RequestOptionsoptions?): IndexCreateResponse { id, export_config_id, name, 10 more }

POST/api/v1/indexes

Sync Index

client.beta.indexes.sync(stringindexID, IndexSyncParams { organization_id, project_id } params?, RequestOptionsoptions?): IndexSyncResponse

POST/api/v1/indexes/{index_id}/sync

List Indexes

client.beta.indexes.list(IndexListParams { organization_id, page_size, page_token, 2 more } query?, RequestOptionsoptions?): PaginatedCursor<IndexListResponse { id, export_config_id, name, 10 more } >

GET/api/v1/indexes

ModelsExpand Collapse

IndexGetResponse { 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?: string | null

Creation datetime

formatdate-time

description?: string | null

Index description.

last_exported_at?: string | null

Last export time.

formatdate-time

last_synced_at?: string | null

Last sync time.

formatdate-time

metadata?: Record<string, unknown>

Build state and diagnostic info.

updated_at?: string | null

Update datetime

formatdate-time

IndexCreateResponse { 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?: string | null

Creation datetime

formatdate-time

description?: string | null

Index description.

last_exported_at?: string | null

Last export time.

formatdate-time

last_synced_at?: string | null

Last sync time.

formatdate-time

metadata?: Record<string, unknown>

Build state and diagnostic info.

updated_at?: string | null

Update datetime

formatdate-time

IndexSyncResponse = unknown

IndexListResponse { 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?: string | null

Creation datetime

formatdate-time

description?: string | null

Index description.

last_exported_at?: string | null

Last export time.

formatdate-time

last_synced_at?: string | null

Last sync time.

formatdate-time

metadata?: Record<string, unknown>

Build state and diagnostic info.

updated_at?: string | null

Update datetime

formatdate-time