The source snapshot remains immutable. The current Document revision must be supplied in If-Match.
Canonical content with an unsupported schema or an attempted
schema 2-to-1 downgrade returns 409 document_schema_version_unsupported.
Restoring an older Document revision retains an existing schema 2 floor.
Path Parameters
document_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
revisionRequired
integer·min 1
Header Parameters
X-CSRF-TokenRequired
string·min 43·max 43
Session-bound CSRF token. It must exactly match the
__Host-assign_csrf cookie sent with the request.
If-MatchRequired
string
Entity tag containing the resource version last observed by the client.
Responses
ETag
string
Quoted decimal optimistic-concurrency version.
idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
workspace_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
pathRequired
string·min 1·max 63
Permanent Workspace-unique URL segment allocated from the title, with a numeric suffix on collision.
codeRequired
string·min 1·max 64
Case-insensitive client input normalized to uppercase by the server.
A code is unique across Projects, Tasks, and Documents in one
Workspace. Internal UUIDs are not a CLI identifier.
project_id
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
titleRequired
string·min 1·max 500
visibilityRequired
string
Values
workspaceprojectpublic
parent_document_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
child_document_countRequired
integer·min 0
public_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
label_ids
string <uuid>[]·max 20
created_by_actor_idRequired
string <uuid>
Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Example0198ac5e-f9b7-7000-8000-000000000001
archived_at
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
revisionRequired
integer·min 1
created_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
updated_atRequired
string <date-time>
RFC 3339 timestamp in UTC.
Example2026-08-15T12:00:00Z
summaryRequired
object
Revision-bound derived convenience text. It is null when the body is shorter than 300 normalized characters, generation is pending, or the stored projection is stale. It is never evidence or a replacement for Document content.
ancestors
object[]·max 32
Ancestor path, root first, present only on rows of a collection page requested with include_descendants=true and only for nested Documents.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
errorRequired
object
Retry-After
integer·min 0
Delay in seconds before retrying, when an expected maintenance end is known.
Cache-Control
string·const no-store
Prevents storage of error responses by clients and intermediaries.
X-Request-ID
string·min 1·max 200
Correlation identifier for the request.
X-Content-Type-Options
string·const nosniff
Prevents user agents from MIME-sniffing the response.
