Sign in
spreadsheets

Publish Spreadsheet

Freeze every source under one snapshot.

post/api/v1/spreadsheets/{spreadsheet_id}/publish

Path parameters

spreadsheet_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' | 'table' | '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. For a document the kind says whether it reads as a written report, plain prose, a single table or a single chart, and :func:app.artifacts.public.doc_body.classify_doc_kind is the only thing that decides.

spreadsheet is reserved for a real spreadsheet artifact (sheets, cells, formulas — PLAN-spreadsheet-artifact.md). A Doc that is one table is a table: two different things must not share one name in the gallery.

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
sourcesobject required

Changes

Changed in 3 of the 28 revisions of this API.47

  • 4df7b22a7dae1See the full diff
    • ○

      removed the transfer_target enum value from the ///// response property for the response status

      response-property-enum-value-removed

  • ae7627cd46da24See the full diff
    • ●

      added the new booking enum value to the ////// response property for the response status

      response-property-enum-value-added

    • ●

      added the new transfer_desk enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property //// to the response with the status

      response-optional-property-added

  • 202b7d85683e22See the full diff
    • ●

      added the new language enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ●

      added the new language_choice enum value to the ///// response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

    • ○

      added the optional property ////// to the response with the status

      response-optional-property-added

Of the 28 revisions, 1 has no diff computed.