Skip to main content
GET
/
query
Query Index
curl --request GET \
  --url https://api.contextone.com/query \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "results": [
      {
        "content": "<string>",
        "metadata": {
          "source": "<string>",
          "score": 123
        }
      }
    ],
    "pagination": {
      "page": 123,
      "per_page": 123,
      "has_more": true
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string

Bearer token (required for private indexes)

X-Org-Id
string

Organization ID (required for private indexes)

Query Parameters

id
string
required

Entity ID

type
enum<string>
required

Entity type

Available options:
repo,
docs
q
string

Query string

version
integer

Specific version ID

page
integer
default:1

Page number

per_page
integer
default:10

Items per page

Required range: x <= 100

Response

200 - application/json

Query results

success
boolean
required
data
object
required
I