Verify a workbook code representation (Beta)

View as Markdown
This endpoint validates a workbook code representation without creating or modifying any workbook. It performs the same validation as the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint but never persists the result, so you can confirm a representation is valid before creating a workbook from it. **Beta**: This documentation describes a private beta feature and is subject to the [Beta features](/docs/sigma-product-releases#beta-features) disclaimer. ### System and user requirements - To perform this operation, you must use API credentials owned by a user assigned an account type with **Create, edit, and publish workbooks** permission. ### Usage notes - The response `valid` field indicates whether the representation passed validation. When `valid` is `false`, the `errors` array describes each validation failure. - The request body is identical to the [/v2/workbooks/spec](https://help.sigmacomputing.com/reference/create-workbook-spec) endpoint. - No workbook is created and no data is persisted by this endpoint. ### Usage scenarios - **Agentic workflows**: Agents can validate a generated representation before committing it to a create or update operation. - **Automation**: Validate representations in CI or migration tooling before applying them.

Authentication

AuthorizationBearer

OAuth authentication of the form <token>.

Request

The request body.
namestringRequired
The name of the workbook.
folderIdstringRequired
The identifier of the folder in which the workbook is located.
schemaVersionenumRequired
The schema version used by this representation of the workbook.
Allowed values:
pageslist of objectsRequired
The pages of the workbook spec and their contents.
themeNameenum or stringOptional

Built-in theme name (Light, Dark, Surface) or org theme UUID.

themeOverridesobjectOptional
layoutstring or nullOptional
Grid layout as XML.
descriptionstringOptional
The description of the workbook.

Response

The response body.
object
A valid workbook code representation.
OR
object
An invalid workbook code representation, with the validation failures.