Skip to main content
Query Endpoint
curl --request POST \
  --url https://api.example.com/api/v1/query/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "top_k": 5,
  "metadata_filters": {}
}
'
{
  "references": [
    {
      "source_name": "<string>",
      "source_type": "<string>",
      "url": "<string>",
      "score": 123,
      "title": "<string>",
      "text": "<string>",
      "extras": {}
    }
  ],
  "raw": [
    "<string>"
  ]
}

Body

application/json
query
string
required
top_k
integer
default:5
metadata_filters
Metadata Filters · object

Response

Successful Response

references
SourceReference · object[]
required
raw
string[] | null