---
title: Search
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api)

[AutoRAG](https://developers.cloudflare.com/api/resources/autorag)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Search

Deprecated: Use AI Search instead.

POST/accounts/{account\_id}/autorag/rags/{id}/search

Searches an AutoRAG.

##### Security

<details>

<summary>API Token</summary>



The preferred authorization scheme for interacting with the Cloudflare API. <a href="https://developers.cloudflare.com/fundamentals/api/get-started/create-token/">Create a token</a>.

**Example:**<code>Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY</code>

</details>

<details>

<summary>API Email + API Key</summary>



The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**<code>X-Auth-Email: user@example.com</code>

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**<code>X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194</code>

</details>

##### Accepted Permissions (at least one required)

`Auto Rag Write`

##### P ath ParametersExpand Collapse

account\_id: string

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

id: string

rag id

maxLength32

minLength1

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%20default%20%3E%20(param)%20id%20%3E%20(schema)>)

##### Body ParametersJSONExpand Collapse

query: string

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20query%20%3E%20(schema)>)

<details>

<summary>

filters: optional object {key, type, value } or object {filters, type }

</summary>

One of the following:

<details>

<summary>

object {key, type, value }

</summary>

key: string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20key">Link to this property</a>

<details>

<summary>

type: "eq"or "ne"or "gt"or 3 more

</summary>

One of the following:

"eq"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"ne"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

"gt"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type%20%3E%20(member)%202">Link to this property</a>

"gte"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type%20%3E%20(member)%203">Link to this property</a>

"lt"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type%20%3E%20(member)%204">Link to this property</a>

"lte"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type%20%3E%20(member)%205">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20type">Link to this property</a>

<details>

<summary>

value: stringor numberor boolean

</summary>

One of the following:

string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20value%20%3E%20(variant)%200">Link to this property</a>

number

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20value%20%3E%20(variant)%201">Link to this property</a>

boolean

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20value%20%3E%20(variant)%202">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%200">Link to this property</a>

<details>

<summary>

object {filters, type }

</summary>

<details>

<summary>

filters: array of object {key, type, value }

</summary>

key: string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20key">Link to this property</a>

<details>

<summary>

type: "eq"or "ne"or "gt"or 3 more

</summary>

One of the following:

"eq"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"ne"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

"gt"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%202">Link to this property</a>

"gte"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%203">Link to this property</a>

"lt"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%204">Link to this property</a>

"lte"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20type%20%3E%20(member)%205">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20type">Link to this property</a>

<details>

<summary>

value: stringor numberor boolean

</summary>

One of the following:

string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20value%20%3E%20(variant)%200">Link to this property</a>

number

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20value%20%3E%20(variant)%201">Link to this property</a>

boolean

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20value%20%3E%20(variant)%202">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters%20%3E%20(items)%20%3E%20(property)%20value">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20filters">Link to this property</a>

<details>

<summary>

type: "and"or "or"

</summary>

One of the following:

"and"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20type%20%3E%20(member)%200">Link to this property</a>

"or"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20type%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201%20%3E%20(property)%20type">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)%20%3E%20(variant)%201">Link to this property</a>

</details>

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20filters%20%3E%20(schema)>)

max\_num\_results: optional number

maximum50

minimum1

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20max_num_results%20%3E%20(schema)>)

<details>

<summary>

ranking\_options: optional object {ranker, score\_threshold }

</summary>

ranker: optional string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20ranking_options%20%3E%20(schema)%20%3E%20(property)%20ranker">Link to this property</a>

score\_threshold: optional number

maximum1

minimum0

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20ranking_options%20%3E%20(schema)%20%3E%20(property)%20score_threshold">Link to this property</a>

</details>

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20ranking_options%20%3E%20(schema)>)

<details>

<summary>

reranking: optional object {enabled, model }

</summary>

enabled: optional boolean

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20reranking%20%3E%20(schema)%20%3E%20(property)%20enabled">Link to this property</a>

<details>

<summary>

model: optional "@cf/baai/bge-reranker-base"or ""

</summary>

One of the following:

"@cf/baai/bge-reranker-base"

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20reranking%20%3E%20(schema)%20%3E%20(property)%20model%20%3E%20(member)%200">Link to this property</a>

""

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20reranking%20%3E%20(schema)%20%3E%20(property)%20model%20%3E%20(member)%201">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20reranking%20%3E%20(schema)%20%3E%20(property)%20model">Link to this property</a>

</details>

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20reranking%20%3E%20(schema)>)

rewrite\_query: optional boolean

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(params)%200%20%3E%20(param)%20rewrite_query%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

result: object {search\_query, data, has\_more, 2 more }

</summary>

search\_query: string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20search_query">Link to this property</a>

<details>

<summary>

data: optional array of object {score, attributes, content, 2 more }

</summary>

score: number

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(items)%20%3E%20(property)%20score">Link to this property</a>

attributes: optional unknown

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(items)%20%3E%20(property)%20attributes">Link to this property</a>

<details>

<summary>

content: optional array of object {text, type }

</summary>

text: optional string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(items)%20%3E%20(property)%20content%20%3E%20(items)%20%3E%20(property)%20text">Link to this property</a>

type: optional string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(items)%20%3E%20(property)%20content%20%3E%20(items)%20%3E%20(property)%20type">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(items)%20%3E%20(property)%20content">Link to this property</a>

file\_id: optional string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(items)%20%3E%20(property)%20file_id">Link to this property</a>

filename: optional string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data%20%3E%20(items)%20%3E%20(property)%20filename">Link to this property</a>

</details>

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20data">Link to this property</a>

has\_more: optional boolean

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20has_more">Link to this property</a>

next\_page: optional string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20next_page">Link to this property</a>

object: optional string

<a href="#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result%20%2B%20(resource)%20autorag%20%3E%20(model)%20autorag_search_response%20%3E%20(schema)%20%3E%20(property)%20object">Link to this property</a>

</details>

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20result>)

success: boolean

[Link to this property](<#(resource)%20autorag%20%3E%20(method)%20search%20%3E%20(network%20schema)%20%3E%20(property)%20success>)

### Search

HTTP

HTTPTypeScriptPythonGoTerraform

```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/autorag/rags/$ID/search \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "query": "query"
        }'
```

200 example

```
{
  "result": {
    "search_query": "search_query",
    "data": [
      {
        "score": 0,
        "attributes": {},
        "content": [
          {
            "text": "text",
            "type": "type"
          }
        ],
        "file_id": "file_id",
        "filename": "filename"
      }
    ],
    "has_more": true,
    "next_page": "next_page",
    "object": "object"
  },
  "success": true
}
```

##### Returns Examples

200 example

```
{
  "result": {
    "search_query": "search_query",
    "data": [
      {
        "score": 0,
        "attributes": {},
        "content": [
          {
            "text": "text",
            "type": "type"
          }
        ],
        "file_id": "file_id",
        "filename": "filename"
      }
    ],
    "has_more": true,
    "next_page": "next_page",
    "object": "object"
  },
  "success": true
}
```