Skip to main content
POST
/
v1
/
query
Run Query
curl --request POST \
  --url https://api.aryn.cloud/v1/query \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "docset_id": "<string>",
  "query": "<string>",
  "plan": {
    "query": "<string>",
    "nodes": {},
    "result_node": 123,
    "llm_prompt": "<unknown>",
    "llm_plan": "<string>"
  },
  "stream": false,
  "summarize_result": false,
  "rag_mode": false
}
'
import requests

url = "https://api.aryn.cloud/v1/query"

payload = {
"docset_id": "<string>",
"query": "<string>",
"plan": {
"query": "<string>",
"nodes": {},
"result_node": 123,
"llm_prompt": "<unknown>",
"llm_plan": "<string>"
},
"stream": False,
"summarize_result": False,
"rag_mode": False
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
docset_id: '<string>',
query: '<string>',
plan: {
query: '<string>',
nodes: {},
result_node: 123,
llm_prompt: '<unknown>',
llm_plan: '<string>'
},
stream: false,
summarize_result: false,
rag_mode: false
})
};

fetch('https://api.aryn.cloud/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.aryn.cloud/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([
'docset_id' => '<string>',
'query' => '<string>',
'plan' => [
'query' => '<string>',
'nodes' => [

],
'result_node' => 123,
'llm_prompt' => '<unknown>',
'llm_plan' => '<string>'
],
'stream' => false,
'summarize_result' => false,
'rag_mode' => false
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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.aryn.cloud/v1/query"

payload := strings.NewReader("{\n \"docset_id\": \"<string>\",\n \"query\": \"<string>\",\n \"plan\": {\n \"query\": \"<string>\",\n \"nodes\": {},\n \"result_node\": 123,\n \"llm_prompt\": \"<unknown>\",\n \"llm_plan\": \"<string>\"\n },\n \"stream\": false,\n \"summarize_result\": false,\n \"rag_mode\": false\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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.aryn.cloud/v1/query")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"docset_id\": \"<string>\",\n \"query\": \"<string>\",\n \"plan\": {\n \"query\": \"<string>\",\n \"nodes\": {},\n \"result_node\": 123,\n \"llm_prompt\": \"<unknown>\",\n \"llm_plan\": \"<string>\"\n },\n \"stream\": false,\n \"summarize_result\": false,\n \"rag_mode\": false\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.aryn.cloud/v1/query")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"docset_id\": \"<string>\",\n \"query\": \"<string>\",\n \"plan\": {\n \"query\": \"<string>\",\n \"nodes\": {},\n \"result_node\": 123,\n \"llm_prompt\": \"<unknown>\",\n \"llm_plan\": \"<string>\"\n },\n \"stream\": false,\n \"summarize_result\": false,\n \"rag_mode\": false\n}"

response = http.request(request)
puts response.read_body
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Body

application/json

A query against a DocSet. Contains either a natural language string or a query plan.

docset_id
string | null

The docset against which to run the query

query
string | null

The natural language query to run. if specified, plan must not be set.

plan
LogicalPlan · object | null

The logical query plan to run. If specified, query must not be set.

stream
boolean
default:false

If true, query results will be streamed back to the client as they are generated. Applies only when calling the query api.

summarize_result
boolean
default:false

If true, an english summary of the result in context of the original query will be returned. Applies only when calling the query API and only available when stream=True

rag_mode
boolean
default:false

If true, the query will only run a RAG query plan.

Response

Successful Response