Sign in
docs

Publish Doc

Freeze every widget in the doc as of now, so later readers see these values with a note if live data moved.

post/api/v1/docs/{doc_id}/publish

Path parameters

doc_idstring uuid required

Request body

expected_versioninteger required

Response

Successful Response

idstring uuid required
titlestring required
state'streaming' | 'draft' | 'edited' | 'approved' | 'sent' | 'archived' required
kind'report' | 'document' | 'spreadsheet' | 'visualization' required

What a document IS, derived from its body — never declared by an author.

Orthogonal to :class:ArtifactType, which says which product surface owns the row. Every kind here is a document; the kind says whether that document reads as a written report, plain prose, a single table or a single chart. :func:app.artifacts.public.doc_body.classify_doc_kind is the only thing that decides.

folder_idstring uuid nullable required
conversation_idstring uuid nullable required
version_numberinteger required
last_author'agent' | 'user' required
last_author_user_idstring uuid nullable required
created_by_user_idstring uuid nullable required
published_versioninteger nullable required
preview_textstring required
created_atstring date-time required
updated_atstring date-time required
bodystring required
body_jsonobject nullable required
provenanceobject required

Changes