Skip to main content
POST
/
query
Query data
curl --request POST \
  --url https://api.vectorify.ai/v1/query \
  --header 'Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "how many invoices are in draft status?",
  "collections": [
    "invoices"
  ],
  "tenant": 235611,
  "identifier": {
    "id": "123",
    "name": "John Doe",
    "email": "[email protected]"
  }
}
'
{
  "data": {
    "id": "<string>",
    "chat_id": "<string>",
    "role": "<string>",
    "text": "<string>",
    "text_html": "<string>",
    "identifier": "<string>",
    "feedback": "<string>",
    "created_at": "<string>",
    "user": {
      "id": "<string>",
      "name": "<string>",
      "email": "<string>",
      "avatar": "<string>",
      "created_at": "<string>"
    }
  }
}

Authorizations

​
Api-Key
string
header
required

Body

application/json
​
text
string
required
Example:

"how many invoices are in draft status?"

​
collections
string[] | null

Array of collection slugs to filter the query.

Example:
["invoices"]
​
tenant
integer | null

Required if the project is multi-tenant.

Example:

235611

​
identifier
object

Optional user identifier data.

Example:
{
  "id": "123",
  "name": "John Doe",
  "email": "[email protected]"
}

Response

ChatMessage

​
data
ChatMessage · object
required