POST
/
v1
/
query
/
plan
Generate Plan
curl --request POST \
  --url https://api.aryn.cloud/v1/query/plan \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "docset_id": "<string>",
  "query": "<string>",
  "plan": {
    "query": "<string>",
    "nodes": {},
    "result_node": 123,
    "llm_prompt": "<any>",
    "llm_plan": "<string>"
  },
  "stream": false,
  "summarize_result": false,
  "rag_mode": false
}'
{
  "query": "<string>",
  "nodes": {},
  "result_node": 123,
  "llm_prompt": "<any>",
  "llm_plan": "<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
object | null

The logical query plan to run. If specified, query must not be set. A logical query plan used to evaluate a query.

​
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

A logical query plan used to evaluate a query.

​
query
string
required

The query that the plan is for.

​
nodes
object
required

A mapping of node IDs to nodes in the query plan.

​
result_node
integer
required

The ID of the node that is the result of the query.

​
llm_prompt
any

The LLM prompt that was used to generate this query plan.

​
llm_plan
string | null

The result generated by the LLM.