v5

latestOpenAPI 3.1.02026-08-025631,1012.8 MB

Retrievers

List Retrievers Get

List all retrievers in the namespace (GET alias for POST /list).

get/v1/retrievers

Query parameters

limitinteger nullable

page_sizeinteger nullable

offsetinteger nullable

pageinteger nullable

cursorstring nullable

next_cursorstring nullable

afterstring nullable

include_totalboolean

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"
        }
      ]
    }
  ]
}