Evaluation

Get query result

Changed on

Retrieve the result of a previous query.

get/evaluate/query/{query_id}

Request

  • Base URL
    https://api.hyperspell.com
  • URL
    https://api.hyperspell.com/evaluate/query/{query_id}
  • Auth
    HTTP bearer

Path parameters

query_idstring required

Headers

X-Hyperspell-Response-Profile'api' | 'mcp'

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

X-As-Userstring nullable

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

Response

Successful Response

query_idstring nullable

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.

errorsobject[] nullable

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.

answerstring nullable

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

disclaimerstring nullable

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

provenanceProvenance (unresolved $ref)
scorenumber nullable

Deprecated: the average score of the query feedback. Only saved-query reads set it; a future release moves it to a separate saved-query response.

querystring nullable

Deprecated: the query string that was issued. Only saved-query reads set it; a future release moves it to a separate saved-query response.

Changes

  • 77d3e8d5e8a7Revision changes
    • warning

      added the new gong enum value to the // response property for the response status

    • warning

      added the new gong enum value to the //// response property for the response status

  • 455cd12eecb3Revision changes
    • breaking

      the response property became optional for the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property /// from the response with the status

    • warning

      removed the optional property // from the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status