POST
/
graph
/
{graph_name}
/
query
curl --request POST \
  --url https://api.circlemind.co/graph/{graph_name}/query \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --data '{
  "query": "<string>",
  "parameters": "<string>"
}'
{
  "requestId": "<string>",
  "requestTime": 123
}

Authorizations

​
apiKey
string
header
required

Path Parameters

​
graph_name
string
required

Body

application/json

Data model for query request.

​
query
string
required
​
parameters
string | null

Optional stringified JSON parameters:

  • only_context (bool = false): return only the context of the query instead of processing it via an LLM;
  • with_references (bool = false): include references in the response.
  • entities_max_tokens, relations_max_tokens, chunks_max_tokens to control the maxmimum amount of tokens allowed in the context. Check the sdk documentation for more information.

(i.e., '{"only_context": true}')

Response

200
application/json
Successful Response

Data model for query response.

​
requestId
string
required

Unique request ID to be used to track the request status

​
requestTime
integer
required

Further value to provide to track the request status