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": "john@example.com"
  }
}
'
import requests

url = "https://api.vectorify.ai/v1/query"

payload = {
"text": "how many invoices are in draft status?",
"collections": ["invoices"],
"tenant": 235611,
"identifier": {
"id": "123",
"name": "John Doe",
"email": "john@example.com"
}
}
headers = {
"Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
text: 'how many invoices are in draft status?',
collections: ['invoices'],
tenant: 235611,
identifier: {id: '123', name: 'John Doe', email: 'john@example.com'}
})
};

fetch('https://api.vectorify.ai/v1/query', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.vectorify.ai/v1/query",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'text' => 'how many invoices are in draft status?',
'collections' => [
'invoices'
],
'tenant' => 235611,
'identifier' => [
'id' => '123',
'name' => 'John Doe',
'email' => 'john@example.com'
]
]),
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.vectorify.ai/v1/query"

payload := strings.NewReader("{\n \"text\": \"how many invoices are in draft status?\",\n \"collections\": [\n \"invoices\"\n ],\n \"tenant\": 235611,\n \"identifier\": {\n \"id\": \"123\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.vectorify.ai/v1/query")
.header("Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"text\": \"how many invoices are in draft status?\",\n \"collections\": [\n \"invoices\"\n ],\n \"tenant\": 235611,\n \"identifier\": {\n \"id\": \"123\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.vectorify.ai/v1/query")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"text\": \"how many invoices are in draft status?\",\n \"collections\": [\n \"invoices\"\n ],\n \"tenant\": 235611,\n \"identifier\": {\n \"id\": \"123\",\n \"name\": \"John Doe\",\n \"email\": \"john@example.com\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "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>"
    }
  }
}
{
"message": "<string>",
"errors": {}
}

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": "john@example.com"
}

Response

ChatMessage

data
ChatMessage · object
required