Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

Send the API generated from the Playground:

  • Authorization: <api_key>

Path Parameters

graph_id
string
required

The graph_id of the knowledge graph from which to retrieve the answer. A graph_id is an alphanumeric string that uniquely identifies a knowledge graph.

retrieval_id
string
required

The retrieval_id of the specific retrieval request. A retrieval_id is an alphanumeric string that uniquely identifies a retrieval request.

Response

200 - application/json
question
string
required

The natural language question that was asked.

timestamp
string<date-time>
required
read-only

The date and time when the retrieval request was created.

retrieval_id
string<uuid>

The alphanumeric string that uniquely identifies the retrieval request.

answer
string | null

The answer generated by the system based on the knowledge graph.

status
enum<string>

The status of the retrieval request.

Available options:
queued,
in_progress,
success,
failed
completed_at
string<date-time> | null

The date and time when the retrieval request was completed.

system
enum<string>
  • rt-0.5 (default) - first retrieval system
Available options:
rt-0.5