Sign in
Retrievers

Update Retriever

Update an existing Retriever.

put/api/v1/retrievers/{retriever_id}

Path parameters

retriever_idstring uuid required

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

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

Changed in 2 of the 33 revisions of this API.4

  • b17341164de92See the full diff
    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    • ○

      added the optional property // to the response with the status

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 01ac7197eb4a2See the full diff
    • ○

      added the new optional query request parameter organization_id

      new-optional-request-parameter

    • ○

      added the new optional query request parameter project_id

      new-optional-request-parameter

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog