Rest API references
apiKey
header of each request:
.detail
).
add
request to the workers. The processing is asynchronous and can be optionally tracked until completion.
YOUR_API_KEY
with your actual API key.
your_graph_name
with the name of your graph.
query
field should contain your query.
parameters
field is an optional JSON string that can include:
only_context
: Set to true
to return only the context of the query instead of processing it via an LLM.
with_references
: Set to true
to 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.
query
request. Upon completion, the querying result can be found in answer
(the LLM generated answer) and context
(the context passed to the LLM).
Note that the same procedure can be used to track add
requests using the endpoint https://api.circlemind.co/graph/{graph_name}/insert/{request_id}
.
For more detailed information on each endpoint, refer to the full API reference at https://docs.circlemind.co/api-reference.