Create document

Create a brand-new document and publish it. Accepts creation metadata (modelId, name, and optional identifier / description / folderId) plus the same content slice as the draft patch body, including queryPresentations, controls, settings, and containers.

Tiles are addressed by their record key in queryPresentations.data (e.g. "1", "2"); the server owns internal tile identity, so you never send miniUuid. A new document starts with a single empty seed tile at key "1" — write to "1" (or send it as null) to replace the seed.

Because this is the first publish of brand-new content, it is not subject to the organization's requirePullRequestToPublish policy (which gates edits to existing content).

Request body

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.

identifierstring

Identifier (URL slug) for the new document. Must be unique within the organization; auto-generated when omitted. Lowercase letters, numbers, hyphens, and underscores only; cannot start or end with a hyphen or underscore.

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).

summarystring

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

containersobject[]

Container layout array (grid / stack / page / reference containers, recursively nested). On a patch, when present this fully replaces the existing layout. The server validates the full structure on apply; container instanceKey / referenceKey values round-trip unchanged. See the dashboard layout reference for the complete grammar.

Response

Document created and published successfully.

identifierstring required

Identifier of the newly created document.