API Reference

AI Search

Namespaces

Instances

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Items

Items List.

aisearch.namespaces.instances.items.list(strid, ItemListParams**kwargs) -> SyncV4PagePaginationArray[ItemListResponse]

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items

Upload Item.

aisearch.namespaces.instances.items.upload(strid, ItemUploadParams**kwargs) -> ItemUploadResponse

POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items

Create or Update Item.

aisearch.namespaces.instances.items.create_or_update(strid, ItemCreateOrUpdateParams**kwargs) -> ItemCreateOrUpdateResponse

PUT/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items

Get Item.

aisearch.namespaces.instances.items.get(stritem_id, ItemGetParams**kwargs) -> ItemGetResponse

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}

Sync Item.

aisearch.namespaces.instances.items.sync(stritem_id, ItemSyncParams**kwargs) -> ItemSyncResponse

PATCH/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}

Delete Item.

aisearch.namespaces.instances.items.delete(stritem_id, ItemDeleteParams**kwargs) -> ItemDeleteResponse

DELETE/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}

Download Item Content.

aisearch.namespaces.instances.items.download(stritem_id, ItemDownloadParams**kwargs) -> BinaryResponseContent

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download

Item Logs.

aisearch.namespaces.instances.items.logs(stritem_id, ItemLogsParams**kwargs) -> ItemLogsResponse

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs

List Item Chunks.

aisearch.namespaces.instances.items.chunks(stritem_id, ItemChunksParams**kwargs) -> ItemChunksResponse

GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks

ModelsExpand Collapse

class ItemListResponse: …

id: str

checksum: str

chunks_count: Optional[int]

created_at: datetime

formatdate-time

file_size: Optional[float]

key: str

last_seen_at: datetime

formatdate-time

namespace: str

next_action: Optional[Literal["INDEX", "DELETE"]]

One of the following:

"INDEX"

"DELETE"

source_id: Optional[str]

Identifies which data source this item belongs to. “builtin” for uploaded files, “{type}:{source}” for external sources, null for legacy items.

status: Literal["queued", "running", "completed", 3 more]

One of the following:

"queued"

"running"

"completed"

"error"

"skipped"

"outdated"

error: Optional[str]

class ItemUploadResponse: …

id: str

checksum: str

chunks_count: Optional[int]

created_at: datetime

formatdate-time

file_size: Optional[float]

key: str

last_seen_at: datetime

formatdate-time

namespace: str

next_action: Optional[Literal["INDEX", "DELETE"]]

One of the following:

"INDEX"

"DELETE"

source_id: Optional[str]

Identifies which data source this item belongs to. “builtin” for uploaded files, “{type}:{source}” for external sources, null for legacy items.

status: Literal["queued", "running", "completed", 3 more]

One of the following:

"queued"

"running"

"completed"

"error"

"skipped"

"outdated"

error: Optional[str]

class ItemCreateOrUpdateResponse: …

id: str

checksum: str

chunks_count: Optional[int]

created_at: datetime

formatdate-time

file_size: Optional[float]

key: str

last_seen_at: datetime

formatdate-time

namespace: str

next_action: Optional[Literal["INDEX", "DELETE"]]

One of the following:

"INDEX"

"DELETE"

source_id: Optional[str]

Identifies which data source this item belongs to. “builtin” for uploaded files, “{type}:{source}” for external sources, null for legacy items.

status: Literal["queued", "running", "completed", 3 more]

One of the following:

"queued"

"running"

"completed"

"error"

"skipped"

"outdated"

error: Optional[str]

class ItemGetResponse: …

id: str

checksum: str

chunks_count: Optional[int]

created_at: datetime

formatdate-time

file_size: Optional[float]

key: str

last_seen_at: datetime

formatdate-time

namespace: str

next_action: Optional[Literal["INDEX", "DELETE"]]

One of the following:

"INDEX"

"DELETE"

source_id: Optional[str]

Identifies which data source this item belongs to. “builtin” for uploaded files, “{type}:{source}” for external sources, null for legacy items.

status: Literal["queued", "running", "completed", 3 more]

One of the following:

"queued"

"running"

"completed"

"error"

"skipped"

"outdated"

error: Optional[str]

class ItemSyncResponse: …

id: str

checksum: str

chunks_count: Optional[int]

created_at: datetime

formatdate-time

file_size: Optional[float]

key: str

last_seen_at: datetime

formatdate-time

namespace: str

next_action: Optional[Literal["INDEX", "DELETE"]]

One of the following:

"INDEX"

"DELETE"

source_id: Optional[str]

Identifies which data source this item belongs to. “builtin” for uploaded files, “{type}:{source}” for external sources, null for legacy items.

status: Literal["queued", "running", "completed", 3 more]

One of the following:

"queued"

"running"

"completed"

"error"

"skipped"

"outdated"

error: Optional[str]

class ItemDeleteResponse: …

key: str

List[ItemLogsResponseItem]

action: str

chunk_count: Optional[int]

error_type: Optional[str]

file_key: str

message: Optional[str]

processing_time_ms: Optional[int]

timestamp: datetime

formatdate-time

List[ItemChunksResponseItem]

id: str

item: ItemChunksResponseItemItem

key: str

metadata: Optional[Dict[str, object]]

timestamp: Optional[float]

text: str

end_byte: Optional[float]

start_byte: Optional[float]