PUT /accounts/{account_id}/ai-search/instances/{id}

Update instances.

Servers

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

Path parameters

Name	Type	Required	Description
`id`	String	Yes	Use your AI Search ID.
`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
`ai_search_model`		No
`reranking`	Boolean	No	Default value: false
`chunk`	Boolean	No	Default value: true
`metadata`	Object	No
`metadata.worker_domain`	String	No
`metadata.created_from_aisearch_wizard`	Boolean	No
`paused`	Boolean	No	Default value: false
`summarization`	Boolean	No	Default value: false
`cache`	Boolean	No	Default value: true
`max_num_results`	Integer	No	Default value: 10
`reranking_model`		No
`chunk_size`	Integer	No	Default value: 256
`rewrite_model`		No
`source_params`	Object	No	Default value: { "r2_jurisdiction": "default" }
`source_params.prefix`	String	No
`source_params.web_crawler`	Object	No	Default value: { "parse_type": "sitemap" }
`source_params.web_crawler.parse_type`	String	No	Valid values: `"feed-rss"` `"sitemap"` Default value: "sitemap"
`source_params.web_crawler.parse_options`	Object	No
`source_params.web_crawler.parse_options.include_headers`	Object	No
`source_params.web_crawler.parse_options.use_browser_rendering`	Boolean	No	Default value: false
`source_params.web_crawler.parse_options.include_images`	Boolean	No	Default value: false
`source_params.web_crawler.store_options`	Object	No
`source_params.web_crawler.store_options.r2_jurisdiction`	String	No	Default value: "default"
`source_params.web_crawler.store_options.storage_id`	String	Yes
`source_params.web_crawler.store_options.storage_type`	String	No	Valid values: `"r2"` Default value: "r2"
`source_params.include_items[]`	Array	No	List of path patterns to include. Supports wildcards (e.g., /blog/.html, /docs/*, \blog*.html)
`source_params.r2_jurisdiction`	String	No	Default value: "default"
`source_params.exclude_items[]`	Array	No	List of path patterns to exclude. Supports wildcards (e.g., /admin/, /private/*, \private*)
`system_prompt_index_summarization`	String	No
`chunk_overlap`	Integer	No	Default value: 10
`summarization_model`		No
`token_id`	String	No
`rewrite_query`	Boolean	No	Default value: false
`score_threshold`	Number	No	Default value: 0.4
`hybrid_search_enabled`	Boolean	No	Default value: false
`public_endpoint_params`	Object	No
`public_endpoint_params.enabled`	Boolean	No	Default value: false
`public_endpoint_params.authorized_hosts[]`	Array	No
`public_endpoint_params.rate_limit`	Object	No
`public_endpoint_params.rate_limit.requests`	Integer	No
`public_endpoint_params.rate_limit.period_ms`	Integer	No
`public_endpoint_params.rate_limit.technique`	String	No	Valid values: `"fixed"` `"sliding"`
`cache_threshold`	String	No	Valid values: `"flexible_friend"` `"super_strict_match"` `"anything_goes"` `"close_enough"` Default value: "close_enough"
`system_prompt_rewrite_query`	String	No
`system_prompt_ai_search`	String	No
`ai_gateway_id`	String	No
`embedding_model`		No

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.