--- description: Manage AI Search instances and sync jobs over HTTP using the Instances REST API. title: REST API image: https://developers.cloudflare.com/og-docs.png --- [Skip to content](#main-content) > Documentation Index > Fetch the complete documentation index at: https://developers.cloudflare.com/ai-search/llms.txt > Use this file to discover all available pages before exploring further. # REST API Last updated Aug 24, 2026|Copy as Markdown|[View as Markdown](https://e8aee267.previews.developers.cloudflare.com/ai-search/api/instances/rest-api/index.md)|[Agent setup](https://e8aee267.previews.developers.cloudflare.com/agent-setup/) Use the AI Search REST API to manage instances and sync jobs over HTTP. ## Authentication All requests require an API token with **AI Search:Edit** and **AI Search:Run** permissions. 1. In the Cloudflare dashboard, go to **My Profile** \> **API Tokens**. [Go to **API Tokens** ↗](https://dash.cloudflare.com/profile/api-tokens) 2. Select **Create Token**. 3. Select **Create Custom Token**. 4. Enter a **Token name**, for example `AI Search Manager`. 5. Under **Permissions**, add two permissions: * **Account** \> **AI Search:Edit** * **Account** \> **AI Search:Run** 6. Select **Continue to summary**, then select **Create Token**. 7. Copy and save the token value. This is your `API_TOKEN`. Include the token in the `Authorization` header for all requests: ```txt Authorization: Bearer ``` ## API paths AI Search APIs are available at two base paths: | Path | Description | | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | /accounts/{account\_id}/ai-search/instances/{id} | Operates on a specific instance | | /accounts/{account\_id}/ai-search/namespaces/{namespace}/instances/{id} | Operates on instances within a [namespace](https://e8aee267.previews.developers.cloudflare.com/ai-search/concepts/namespaces/) | The available operations are the same for both paths. For the namespace-scoped API, refer to the [Namespace API reference](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/namespaces/). ## Instances Create, list, get, update, and delete AI Search instances. For the full specification, refer to the [Instances API reference](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/). | Operation | Method | Description | | ------------------------------------------------------------------------------------------------------------------------------ | ------ | ----------------------------- | | [Create](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/methods/create/) | POST | Create a new instance | | [List](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/methods/list/) | GET | List all instances | | [Get](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/methods/read/) | GET | Get an instance by ID | | [Update](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/methods/update/) | PUT | Update instance configuration | | [Delete](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/methods/delete/) | DELETE | Delete an instance | | [Stats](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/methods/stats/) | GET | Get indexing statistics | ### Example: Create an instance Create an instance in the default namespace: ```bash curl -X POST "https://api.cloudflare.com/client/v4/accounts//ai-search/instances" \ -H "Authorization: Bearer " \ -H "Content-Type: application/json" \ -d '{ "id": "my-instance" }' ``` ## Jobs Trigger and monitor [sync jobs](https://e8aee267.previews.developers.cloudflare.com/ai-search/configuration/indexing/syncing/) that scan your data source and index new or updated content. For the full specification, refer to the [Jobs API reference](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/subresources/jobs/). | Operation | Method | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ----------------------------- | | [Create](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/subresources/jobs/methods/create/) | POST | Trigger a new sync job | | [List](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/subresources/jobs/methods/list/) | GET | List all jobs for an instance | | [Get](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/subresources/jobs/methods/read/) | GET | Get job details | | [Logs](https://e8aee267.previews.developers.cloudflare.com/api/resources/ai%5Fsearch/subresources/instances/subresources/jobs/methods/logs/) | GET | View job logs | ### Example: Trigger a sync job Start a new sync job for an instance: ```bash curl -X POST "https://api.cloudflare.com/client/v4/accounts//ai-search/instances//jobs" \ -H "Authorization: Bearer " ``` Was this helpful? YesNo ## On this page [![](https://e8aee267.previews.developers.cloudflare.com/_astro/logo.te5VL_aD.svg)Docs](https://e8aee267.previews.developers.cloudflare.com/) ```json {"@context":"https://schema.org","@type":"TechArticle","@id":"https://developers.cloudflare.com/ai-search/api/instances/rest-api/#page","headline":"REST API · Cloudflare AI Search docs","description":"Manage AI Search instances and sync jobs over HTTP using the Instances REST API.","url":"https://developers.cloudflare.com/ai-search/api/instances/rest-api/","inLanguage":"en","image":"https://developers.cloudflare.com/og-docs.png","dateModified":"2026-08-24","publisher":{"@type":"Organization","name":"Cloudflare","url":"https://www.cloudflare.com/"},"isPartOf":{"@type":"WebSite","@id":"https://developers.cloudflare.com/#website","name":"Cloudflare Docs","url":"https://developers.cloudflare.com/"}} ```