Sign in
Retrievers

List Retrievers

List all retrievers in the namespace.

post/v1/retrievers/list

Query parameters

limitinteger nullable
page_sizeinteger nullable
offsetinteger nullable
pageinteger nullable
cursorstring nullable
next_cursorstring nullable
afterstring nullable
include_totalboolean

Request body

searchstring nullable

Search term for wildcard search across retriever_id, retriever_name, description, and other text fields

filtersobject nullable

Filters applied directly to the query — any stored field works, e.g. {"collection_ids": {"$in": ["col_x"]}} to filter by collection, or {"retriever_name": "..."}.

sortsobject[] nullable

Sort options for the retriever list

case_sensitiveboolean

If True, filters and search will be case-sensitive

Example request

{
  "sort": {
    "field": "created_at"
  }
}

Response

Successful Response

totalinteger

Total number of retrievers.

Example response

{
  "results": [
    {
      "budget_limits": {
        "max_credits": 100,
        "max_time_ms": 60000
      },
      "collection_ids": [
        "col_marketing_ads"
      ],
      "input_schema": {
        "query_text": {
          "description": "Full-text query",
          "type": "string"
        }
      },
      "retriever_id": "ret_abc123",
      "retriever_name": "executive_ads_search",
      "stages": [
        {
          "config": {
            "parameters": {
              "field": "metadata.spend",
              "operator": "gt",
              "value": 1000
            },
            "stage_name": "attribute_filter",
            "version": "v1"
          },
          "name": "filter_high_spend",
          "stage_type": "filter"
        }
      ]
    }
  ]
}

Changes

Changed in 3 of the 33 revisions of this API.6

  • 5d4c905106b41See the full diff
    • ○

      the endpoint scheme security BearerAuth AND NamespaceHeader was added to the API

      api-security-added

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

  • 72cc17ba6f7f2See the full diff
    • ○

      added the new optional query request parameter after

      new-optional-request-parameter

    • ○

      added the new optional query request parameter next_cursor

      new-optional-request-parameter

  • 7cb0515333113See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

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

      response-required-property-added

    • ○

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

      response-required-property-added

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