API & SDKsCollections

Update collection

Update an existing collection’s configuration.

This endpoint allows updating the name and description of an existing collection. The user must have appropriate permissions to modify the collection.

Path parameters

idstringRequired

The unique identifier of the collection to update

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KeystringRequired

Request

This endpoint expects an object.
namestringOptional

The name of the collection

descriptionstringOptional

An optional description of the collection

generate_descriptionbooleanOptional

Whether to generate a new synthetic description for the collection

Response

Successful Response

resultsobject

Errors