Skip to content
Cloudflare API
Start here
API Reference
AI Search
Namespaces
Instances
Items

Items List.

aisearch.namespaces.instances.items.list(strid, ItemListParams**kwargs) -> SyncV4PagePaginationArray[ItemListResponse]
GET/accounts/{account_id}/ai-search/namespaces/{name}/instances/{id}/items

Lists indexed items in an AI Search instance.

Security
API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY
API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194
ParametersExpand Collapse
account_id: str
name: str
id: str

AI Search instance ID. Lowercase alphanumeric, hyphens, and underscores.

maxLength64
minLength1
item_id: Optional[str]

Filter items by their unique ID. Returns at most one item.

maxLength64
metadata_filter: Optional[str]

JSON-encoded metadata filter using Vectorize filter syntax. Examples: {“folder”:“reports/”}, {“timestamp”:{“$gte”:1700000000000}}, {“folder”:{“$in”:[“docs/”,“reports/”]}}

maxLength2048
page: Optional[int]
minimum1
per_page: Optional[int]
maximum50
minimum0
sort_by: Optional[Literal["status", "modified_at"]]

Sort order for items. “status” (default) sorts by status priority then last_seen_at. “modified_at” sorts by file modification time (most recent first), falling back to created_at.

One of the following:
"status"
"modified_at"
source: Optional[str]

Filter items by source_id. Use “builtin” for uploaded files, or a source identifier like “web-crawler:https://example.com”.

maxLength512
status: Optional[Literal["queued", "running", "completed", 3 more]]
One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
ReturnsExpand 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]

Items List.

import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_token=os.environ.get("CLOUDFLARE_API_TOKEN"),  # This is the default and can be omitted
)
page = client.aisearch.namespaces.instances.items.list(
    id="my-ai-search",
    account_id="c3dc5f0b34a14ff8e1b3ec04895e1b22",
    name="my-namespace",
)
page = page.result[0]
print(page.id)
{
  "result": [
    {
      "id": "id",
      "checksum": "checksum",
      "chunks_count": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_size": 0,
      "key": "key",
      "last_seen_at": "2019-12-27T18:11:19.117Z",
      "namespace": "namespace",
      "next_action": "INDEX",
      "source_id": "source_id",
      "status": "queued",
      "error": "error"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "total_count": 0,
    "per_page": 5
  },
  "success": true
}
Returns Examples
{
  "result": [
    {
      "id": "id",
      "checksum": "checksum",
      "chunks_count": 0,
      "created_at": "2019-12-27T18:11:19.117Z",
      "file_size": 0,
      "key": "key",
      "last_seen_at": "2019-12-27T18:11:19.117Z",
      "namespace": "namespace",
      "next_action": "INDEX",
      "source_id": "source_id",
      "status": "queued",
      "error": "error"
    }
  ],
  "result_info": {
    "count": 0,
    "page": 0,
    "total_count": 0,
    "per_page": 5
  },
  "success": true
}