Sign in
queries

Get Query

One stored query with its request body, response body and the retrieved chunks in one normalised shape (results[]: rank, score, text, filename, document id and a page, time or sheet location, whether the query ran on v2 or v3).

query_id is the id from GET /v2/queries or the query_id field of a query response. The request_id a query response returns (req_...) is accepted in its place, so a query can be fetched straight after running it.

body_status says what came back: available, archived (bodies are archived 90 days after the query and only the summary remains) or missing. A query from another organization or environment is a 404, the same as an unknown id.

get/v2/queries/{query_id}

Path parameters

query_idstring required

Headers

authorizationstring nullable

Response

Successful Response

query_idstring required
query_textstring nullable
collection_namestring nullable
environmentstring nullable
statusstring nullable
api_versionstring nullable
created_atstring nullable
latency_msinteger nullable
result_countinteger nullable
request_idstring nullable
requestQueryDetailV2Request
responseQueryDetailV2Response
body_statusstring required
error_messagestring nullable
error_typestring nullable

Changes

Changed in 3 of the 13 revisions of this API.124

  • 61a9364ad042122See the full diff
    • ▲

      removed the required property from the response with the status

      response-required-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ○

      the response property became required for the status

      response-property-became-required

    • ○

      added the required property to the response with the status

      response-required-property-added

    This revision also has 10 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d07ce37834941See the full diff
    • ○

      api operation id get-query-v-2 removed and replaced with queries_get_query_v2

      api-operation-id-removed

  • 8a4e045bc3fa1See the full diff
    • ○

      endpoint added

      endpoint-added