v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB

Models

Create model

Create a new model. Supports creating schema, shared, branch, shared_extension, and query models. A query model (modelKind QUERY) is created empty under a workbook model (baseModelId); populate its views and fields via the model YAML endpoint.

post/api/v1/models

Request body

allowAsWorkbookBaseboolean

Allow this model as a workbook base

baseModelIdstring

Base model ID for extension or branch models

connectionIdstring required

Connection ID for the model

modelNamestring

Name for the model

usesIsolatedBranchesboolean

For SHARED_EXTENSION models, controls if branches are shown on extension model page instead of parent shared model

Response

Model created successfully

errorstring

Error message if creation failed

messagestring

Additional message

successboolean required

Whether the operation succeeded