Skip to main content
POST
List Retrievers

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer | null
Required range: 1 <= x <= 1000
page_size
integer | null
Required range: 1 <= x <= 1000
offset
integer | null
Required range: 0 <= x <= 10000
page
integer | null
Required range: x >= 1
cursor
string | null
include_total
boolean
default:false

Body

application/json

Request to list retrievers.

search
string | null

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

filters
Filters · object | null

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

sorts
Sorts · object[] | null

Sort options for the retriever list

sort
SortOption · object | null

Single sort option (alias for the first entry of sorts). Every other list resource accepts this shape, so callers reach for it here too; without it, a sort on retrievers was silently dropped and DESC returned ASC order (BACKE-2792 class).

case_sensitive
boolean
default:false

If True, filters and search will be case-sensitive

Response

Successful Response

Response from listing retrievers.

results
RetrieverModel · object[]

List of retrievers in the namespace.

total
integer
default:0

Total number of retrievers.

pagination
PaginationResponse · object | null

Pagination details (next/previous cursors and total).