Skip to content
Start here

Items

Items List.
GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items
Upload Item.
POST/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items
Create or Update Item.
PUT/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items
Get Item.
GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}
Sync Item.
PATCH/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}
Delete Item.
DELETE/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}
Download Item Content.
GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/download
Item Logs.
GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/logs
List Item Chunks.
GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items/{item_id}/chunks
ModelsExpand Collapse
ItemListResponse object { id, checksum, chunks_count, 9 more }
id: string
checksum: string
chunks_count: number
created_at: string
formatdate-time
file_size: number
key: string
last_seen_at: string
formatdate-time
namespace: string
next_action: "INDEX" or "DELETE"
One of the following:
"INDEX"
"DELETE"
source_id: string

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

status: "queued" or "running" or "completed" or 3 more
One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
error: optional string
ItemUploadResponse object { id, checksum, chunks_count, 9 more }
id: string
checksum: string
chunks_count: number
created_at: string
formatdate-time
file_size: number
key: string
last_seen_at: string
formatdate-time
namespace: string
next_action: "INDEX" or "DELETE"
One of the following:
"INDEX"
"DELETE"
source_id: string

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

status: "queued" or "running" or "completed" or 3 more
One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
error: optional string
ItemCreateOrUpdateResponse object { id, checksum, chunks_count, 9 more }
id: string
checksum: string
chunks_count: number
created_at: string
formatdate-time
file_size: number
key: string
last_seen_at: string
formatdate-time
namespace: string
next_action: "INDEX" or "DELETE"
One of the following:
"INDEX"
"DELETE"
source_id: string

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

status: "queued" or "running" or "completed" or 3 more
One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
error: optional string
ItemGetResponse object { id, checksum, chunks_count, 9 more }
id: string
checksum: string
chunks_count: number
created_at: string
formatdate-time
file_size: number
key: string
last_seen_at: string
formatdate-time
namespace: string
next_action: "INDEX" or "DELETE"
One of the following:
"INDEX"
"DELETE"
source_id: string

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

status: "queued" or "running" or "completed" or 3 more
One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
error: optional string
ItemSyncResponse object { id, checksum, chunks_count, 9 more }
id: string
checksum: string
chunks_count: number
created_at: string
formatdate-time
file_size: number
key: string
last_seen_at: string
formatdate-time
namespace: string
next_action: "INDEX" or "DELETE"
One of the following:
"INDEX"
"DELETE"
source_id: string

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

status: "queued" or "running" or "completed" or 3 more
One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
error: optional string
ItemDeleteResponse object { key }
key: string
ItemLogsResponse = array of object { action, chunkCount, errorType, 4 more }
action: string
chunkCount: number
errorType: string
fileKey: string
message: string
processingTimeMs: number
timestamp: string
formatdate-time
ItemChunksResponse = array of object { id, item, text, 2 more }
id: string
item: object { key, metadata, timestamp }
key: string
metadata: optional map[unknown]
timestamp: optional number
text: string
end_byte: optional number
start_byte: optional number