Search

Deprecated

POST/accounts/{account_id}/autorag/rags/{id}/search

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

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

Example:X-Auth-Email: user@example.com

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

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Auto Rag Write

Path ParametersExpand Collapse

account_id: string

id: string

rag id

maxLength32

minLength1

Body ParametersJSONExpand Collapse

query: string

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

One of the following:

object { key, type, value }

key: string

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

One of the following:

"eq"

"ne"

"gt"

"gte"

"lt"

"lte"

value: string or number or boolean

One of the following:

string

number

boolean

object { filters, type }

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

key: string

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

One of the following:

"eq"

"ne"

"gt"

"gte"

"lt"

"lte"

value: string or number or boolean

One of the following:

string

number

boolean

type: "and" or "or"

One of the following:

"and"

"or"

max_num_results: optional number

maximum50

minimum1

ranking_options: optional object { ranker, score_threshold }

ranker: optional string

score_threshold: optional number

maximum1

minimum0

reranking: optional object { enabled, model }

enabled: optional boolean

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

One of the following:

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

rewrite_query: optional boolean

ReturnsExpand Collapse

result: object { search_query, data, has_more, 2 more }

search_query: string

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

score: number

attributes: optional unknown

content: optional array of object { text, type }

text: optional string

type: optional string

file_id: optional string

filename: optional string

has_more: optional boolean

next_page: optional string

object: optional string

success: boolean

Search

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"
        }'

{
  "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

{
  "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
}