Sign in
Retrievers

Get Retriever

Get a Retriever by ID.

get/api/v1/retrievers/{retriever_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

retriever_idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Response

Successful Response

namestring required

A name for the retriever tool. Will default to the pipeline name if not provided.

idstring uuid required

Unique identifier

created_atstring date-time nullable

Creation datetime

updated_atstring date-time nullable

Update datetime

project_idstring uuid required

The ID of the project this retriever resides in.

Changes

No recorded changes to this operation across all 6 revisions of this API.