Create a new collection

POST

Create a new collection and automatically add the creating user to it.

This endpoint allows authenticated users to create a new collection with a specified name and optional description. The user creating the collection is automatically added as a member.

Headers

X-API-KeystringRequired

Request

This endpoint expects an object.

namestringRequired

The name of the collection

descriptionstringOptional

An optional description of 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.create(
7	name="My New Collection",
8	description="This is a sample collection"
9	)

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	}