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

Creates or updates an indexed item in an AI Search instance.

Servers

https://api.cloudflare.com/client/v4

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

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

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
`key`	String	Yes	Item key / filename. Must not exceed 128 characters.
`next_action`	String	Yes	Valid values: `"INDEX"`

wait_for_completion

Boolean

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

key

String

Yes

Item key / filename. Must not exceed 128 characters.

next_action

String

Yes

Valid values:

"INDEX"

How to start integrating

Add HTTP Task to your workflow definition.
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.
Click Test request to test run your request to the API and see the API's response.