Update Document metadata
Update Document metadata
/api/v1/documents/{document_id}Applies an optimistic compare-and-swap to Document metadata. Content is replaced through the separate content operation so a title rename never competes with an autosave for the same revision. Public Document creation and transitions to public visibility require the Workspace's public-publishing billing entitlement; denial returns 403 paid_workspace_required. Unpublishing and ordinary edits of an existing publication remain available subject to normal authorization. Public links are unavailable while the entitlement is absent.
Path Parameters
Header Parameters
string·min 43·max 43Session-bound CSRF token. It must exactly match the
__Host-assign_csrf cookie sent with the request.
string·min 16·max 200Opaque client-generated key for safely retrying this operation.
Request Body
application/jsonstring <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
Responses
stringQuoted decimal optimistic-concurrency version.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string·min 1·max 63Permanent Workspace-unique URL segment allocated from the title, with a numeric suffix on collision.
string·min 1·max 64Case-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.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
string <uuid>Opaque Assign-owned UUIDv7 identifier. Clients must not derive meaning from it.
objectRevision-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.
integer·min 0Delay in seconds before retrying, when an expected maintenance end is known.
string·const no-storePrevents storage of error responses by clients and intermediaries.
string·min 1·max 200Correlation identifier for the request.
string·const nosniffPrevents user agents from MIME-sniffing the response.