Retrievers

Create Retriever

Create a new Retriever.

post/api/v1/retrievers

Query parameters

project_idstring uuid nullable
organization_idstring uuid nullable

Cookies

sessionstring nullable

Request body

namestring required

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

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 1 of the 33 revisions of this API.2

    • added the optional property detail/items/ctx to the response with the 422 status

      response-optional-property-added

    • added the optional property detail/items/input to the response with the 422 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