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

Lists indexed items in an AI Search instance.

Servers

Path parameters

Name Type Required Description
id String Yes

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

name String Yes

Namespace name

account_id String Yes

Query parameters

Name Type Required Description
page Integer No

Default value: 1

source String No

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

per_page Integer No

Default value: 20

search String No
status String No

Valid values:

  • "skipped"
  • "outdated"
  • "completed"
  • "error"
  • "queued"
  • "running"
sort_by String No

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.

Valid values:

  • "modified_at"
  • "status"

Default value: "status"

metadata_filter String No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.