Skip to content

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

ModelsExpand Collapse

IndexGetResponse = object { id, export_config_id, name, 9 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.

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

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