Skip to main content
PATCH
Rename a document collection

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

collection_id
string<uuid>
required

Body

application/json
name
string

Response

Updated

A named grouping of documents within a project. Membership is the Document.collection foreign key (single collection per document); a mirrored ["tag", slug] pair is also kept on each document's metadata so the retrieval/extraction layers can scope to a collection.

name
string
required

Human-readable label (editable).

id
string<uuid>
read-only
slug
string
read-only

Stable identifier documents are linked by. Derived from name at creation and immutable afterwards (renaming changes only name).

document_count
integer
read-only

Number of active documents in this collection (server-annotated).

created_at
string<date-time>
read-only
updated_at
string<date-time>
read-only