Retrievers

Update Retriever

Changed on

Update an existing Retriever.

put/api/v1/retrievers/{retriever_id}

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/retrievers/{retriever_id}
  • Auth: HTTP bearer

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

  • a38b684f8e1bRevision changes
    • info

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

    • info

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

  • 614771991b52Revision changes
    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status