Skip to main content
POST
/
v2
/
documentation
/
search
Core - Search documentation
curl --request POST \
  --url 'https://api.orq.ai/v2/documentation/search' \
  --header 'Authorization: Bearer $ORQ_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "query": "How do I create an API key?",
    "limit": 5,
    "score_threshold": 0.65
  }'

{
  "results": [
    {
      "content": "<string>",
      "path": "<string>",
      "metadata": {
        "title": "<string>",
        "description": "<string>",
        "href": "<string>",
        "icon": "<string>"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
query
string
required

Free-text query to search the documentation for.

​
limit
integer<int32>

Maximum number of results to return (1-50). Defaults to 10.

​
score_threshold
number<double>

Minimum relevance score (0-1). Defaults to 0.6.

Response

200 - application/json

OK

​
results
object[]
required

Documentation pages matching the query, ordered by relevance.