POST
/
queries
/
top-snippets
curl --request POST \
  --url https://api.zeroentropy.dev/v1/queries/top-snippets \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "collection_name": "<string>",
  "query": "<string>",
  "k": 123,
  "filter": {},
  "precise_responses": false,
  "latency_mode": "low",
  "include_document_metadata": false
}'
{
  "results": [
    {
      "path": "<string>",
      "start_index": 123,
      "end_index": 123,
      "page_span": [
        123
      ],
      "content": "<string>",
      "score": 123
    }
  ],
  "document_results": [
    {
      "path": "<string>",
      "score": 123,
      "metadata": {},
      "file_url": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Response

200
application/json

Successful Response

The response is of type object.