Beta
Retrievers

Query Retrievers

Changed on

List the retrievers in a project, newest first.

get/api/v1/beta/retrievers

Request

  • Base URL: https://api.cloud.llamaindex.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.cloud.llamaindex.ai/api/v1/beta/retrievers
  • Auth: HTTP bearer

Query parameters

namestring nullable
page_sizeinteger

Number of items per page

page_tokenstring nullable

Cursor from the previous page's next_page_token.

include_totalboolean

Return total_size, a count of every row matching the filter. It is a second query on every page, so it is off unless asked for.

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

next_page_tokenstring nullable

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_sizeinteger nullable

The total number of items available. This is only populated when specifically requested. The value may be an estimate and can be used for display purposes only.

Changes