Sign in
Retrievers

Update Retriever

Update an existing Retriever.

put/api/v1/retrievers/{retriever_id}

Request

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

Path parameters

retriever_idstring uuid required

Cookies

sessionstring nullable

Request body

namestring nullable

A name for the retriever.

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.