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

Syncs an item to an AI Search instance index.

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
item_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
wait_for_completion Boolean No

Wait for indexing to fully complete before responding. On RAGs with vector indexing enabled, this additionally waits for Vectorize ingestion confirmation (up to 40s) so the returned item reflects a queryable state. On timeout the item is returned in running state and the background alarm continues polling. Defaults to false.

Default value: false

next_action String Yes

Valid values:

  • "INDEX"

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.