Skip to main content
GET
Get query result

Authorizations

Authorization
string
header
required

API Key or JWT User Token. If using an API Key, set the X-As-User header to act as a specific user. A JWT User Token is always scoped to a specific user.

Headers

X-Hyperspell-Response-Profile
enum<string>
default:api

Document response budget: api scales with result count; mcp uses 256 KiB.

Available options:
api,
mcp
X-As-User
string | null

Optionally set this header to act as a specific user when using an API Key, equivalent to first exchanging the API Key for a User Token

Path Parameters

query_id
string
required

Response

Successful Response

query_id
string | null

The ID of the query. This can be used to retrieve the query later, or add feedback to it. If the query failed, this will be None.

errors
Errors · object[] | null

Errors that occurred during the query. These are meant to help the developer debug the query, and are not meant to be shown to the user.

documents
ScoredDocumentResponse · object[]

The matching documents, each carrying its hyperdoc tree plus query-path score, highlights, and summary.

answer
string | null

The answer to the query, if the request was set to answer.

disclaimer
string | null

Privacy notice for the answer, when applicable. If present, callers must display it alongside the answer.

provenance
Provenance · object | null

Auditability record (source documents, entities, search trajectory, failed sources), if the request set provenance=True on a very_high query.

score
number | null

The average score of the query feedback, if any.

query
string | null

The query string that was issued.