instances_items

Creates, updates, deletes, gets or lists an instances_items resource.

Overview

Name	instances_items
Type	Resource
Id	cloudflare.aisearch.instances_items

Fields

The following fields are returned by SELECT queries:

list_by_account

Returns the AI Search items.

Name	Datatype	Description
id	string
source_id	string	Identifies which data source this item belongs to. "builtin" for uploaded files, "{type}:{source}" for external sources, null for legacy items.
checksum	string
chunks_count	integer
created_at	string (date-time)
error	string
file_size	number
key	string
last_seen_at	string (date-time)
namespace	string
next_action	string	(INDEX, DELETE, )
status	string	(queued, running, completed, error, skipped, outdated)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_by_account	select	id, account_id, name	page, per_page, search, sort_by, status, source, metadata_filter, item_id	Lists indexed items in an AI Search instance.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
id	string	Resource ID.
name	string	Resource name.
item_id	string	Filter items by their unique ID. Returns at most one item.
metadata_filter	string	JSON-encoded metadata filter using Vectorize filter syntax. Examples: {"folder":"reports/"}, {"timestamp":{"$gte":1700000000000}}, {"folder":{"$in":["docs/","reports/"]}}
page	integer
per_page	integer
search	string
sort_by	string	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.
source	string	Filter items by source_id. Use "builtin" for uploaded files, or a source identifier like "web-crawler:https://example.com".
status	string

SELECT examples

list_by_account

Lists indexed items in an AI Search instance.

SELECT
id,
source_id,
checksum,
chunks_count,
created_at,
error,
file_size,
key,
last_seen_at,
namespace,
next_action,
status
FROM cloudflare.aisearch.instances_items
WHERE id = '{{ id }}' -- required
AND account_id = '{{ account_id }}' -- required
AND name = '{{ name }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
AND search = '{{ search }}'
AND sort_by = '{{ sort_by }}'
AND status = '{{ status }}'
AND source = '{{ source }}'
AND metadata_filter = '{{ metadata_filter }}'
AND item_id = '{{ item_id }}'
;