Skip to main content
POST
/
query
/
customer
Query a customer
curl --request POST \
  --url https://api.liquidindex.dev/query/customer \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customer_id": "<string>",
  "query": "<string>",
  "top_k": 5,
  "include_llm": true
}
'
{
  "results": {
    "chunks": [
      {
        "score": 123,
        "content": "<string>",
        "metadata": {
          "id": "<string>",
          "file": "<string>",
          "source": "<string>",
          "type": "<string>"
        }
      }
    ],
    "llm": "<string>"
  },
  "usage": {
    "read_units": 123,
    "embedding_units": 123
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
customer_id
string
required

The Customer ID to query from

​
query
string
required

The input text used to find similar matches

​
top_k
integer
default:5

Number of matches to return

​
include_llm
boolean
default:true

Whether to include the LLM response in the response

Response

Successful query response

​
results
object
required
​
usage
object
required