/api/agent

POST /api/agent/v1/search

Changed on

Search for tables, models, metrics, saved questions, dashboards, and collections.

Supports both term-based and semantic search queries. Results are ranked using Reciprocal Rank Fusion when both query types are provided.

post/api/agent/v1/search

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

Response

Successful response

total_countinteger required

Changes

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • breaking

      removed subschema #1 subschema #2 from the request property oneOf list

    • warning

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

    • warning

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

    • warning

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

    • warning

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

    • info

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

    • info

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

    • 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 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

      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

      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

      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

      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

      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

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

    • info

      request property / list-of-types was widened by adding types string to media type application/json

    • info

      request property / list-of-types was widened by adding types string to media type application/json