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

Items List.

client.aiSearch.namespaces.instances.items.list(stringname, stringid, ItemListParams { account_id, item_id, metadata_filter, 6 more } params, RequestOptionsoptions?): V4PagePaginationArray<ItemListResponse { id, checksum, chunks_count, 9 more } >
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
name: string
id: string

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

maxLength64
minLength1
params: ItemListParams { account_id, item_id, metadata_filter, 6 more }
account_id: string

Path param

item_id?: string

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

maxLength64
metadata_filter?: string

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

maxLength2048
page?: number

Query param

minimum1
per_page?: number

Query param

maximum50
minimum0
sort_by?: "status" | "modified_at"

Query param: 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?: string

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

maxLength512
status?: "queued" | "running" | "completed" | 3 more

Query param

One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
ReturnsExpand Collapse
ItemListResponse { id, checksum, chunks_count, 9 more }
id: string
checksum: string
chunks_count: number | null
created_at: string
formatdate-time
file_size: number | null
key: string
last_seen_at: string
formatdate-time
namespace: string
next_action: "INDEX" | "DELETE" | null
One of the following:
"INDEX"
"DELETE"
source_id: string | null

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

status: "queued" | "running" | "completed" | 3 more
One of the following:
"queued"
"running"
"completed"
"error"
"skipped"
"outdated"
error?: string

Items List.

import Cloudflare from 'cloudflare';

const client = new Cloudflare({
  apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const itemListResponse of client.aiSearch.namespaces.instances.items.list(
  'my-namespace',
  'my-ai-search',
  { account_id: 'c3dc5f0b34a14ff8e1b3ec04895e1b22' },
)) {
  console.log(itemListResponse.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
}