/api/agent

POST /api/agent/v2/query

Changed on

Execute a portable MBQL 5 representations JSON query and stream the results, with continuation-token pagination.

Accepts either a JSON body (same shape as /v2/construct-query) or a continuation_token from a previous response. Returns results with column metadata and an optional continuation_token for fetching the next page.

post/api/agent/v2/query

Request

  • Base URL
    (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    API key in header X-API-Key

Request body

OR
OR

Response

Successful response

continuation_tokenstring nullable
errorstring
row_countinteger
running_timeinteger
status'completed' | 'failed' required

Changes

    • breaking

      removed subschema #1 from the request body oneOf list

    • info

      added subschema #1 subschema #2 to the request body anyOf list

    • info

      added subschema #1 subschema #2 to the response property anyOf list for the response status

    • info

      added subschema #1 subschema #2 to the /// response property anyOf list for the response status

    • info

      removed subschema #1 subschema #2 from the response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 from the /// response property oneOf list for the response status

    • info

      endpoint added