Update collection

POST

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

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

Built with

1	from r2r import R2RClient
2
3	client = R2RClient()
4	# when using auth, do client.login(...)
5
6	result = client.collections.update(
7	"123e4567-e89b-12d3-a456-426614174000",
8	name="Updated Collection Name",
9	description="Updated description"
10	)

1	{
2	"results": {
3	"id": "id",
4	"name": "name",
5	"graph_cluster_status": "graph_cluster_status",
6	"graph_sync_status": "graph_sync_status",
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"user_count": 1,
10	"document_count": 1,
11	"owner_id": "owner_id",
12	"description": "description"
13	}
14	}