Create document

Create a brand-new document and publish it live. Accepts creation metadata (modelId, name, optional identifier / description / folderId) plus the same content slice as the PATCH body — queryPresentations, controls, settings, containers. The server mints internal tile identifiers, so callers omit miniUuid. Tiles in queryPresentations are merged by key over the single empty seed tile at key "1"; write to "1" (or send it as null) to replace the seed.

When containers is omitted, every dashboard-eligible tile is auto-placed in a default layout. When containers is present, it fully defines the layout — tiles it does not reference are stored but not rendered. Send containers: null to create a workbook-only document with no dashboard (controls and settings must then be omitted); an empty containers: [] is rejected.

The new document is published live before the response returns. As a first publish of brand-new content it is not subject to the org’s requirePullRequestToPublish policy (which gates edits to existing content).

Request body

descriptionstring nullable

Document description.

folderIdstring uuid nullable

Folder to create the document in. When omitted, defaults to the caller’s personal "My documents" (requires permission to save personal content — otherwise the request is rejected).

identifierstring

Identifier for the new document. Must be unique within the organization. Auto-generated when omitted.

modelIdstring uuid required

Base workbook model the document is built on — a SHARED model, or a SHARED_EXTENSION with allowAsWorkbookBase = true.

namestring required

Document name.

summarystring

Optional. Caller-supplied note describing the create, written to the history audit trail. When omitted, the server auto-fills it with "Created document".

Response

Document created and published successfully.

descriptionstring nullable required