Sign in

v4

latestOpenAPI 3.1.02026-08-01207318738.7 KB
Models

Get model YAML

get/api/v1/models/{modelId}/yaml

Path parameters

modelIdstring uuid required

Model UUID

Example:123e4567-e89b-12d3-a456-426614174000

Model UUID

Query parameters

branchIdstring uuid

Branch ID for branch-aware operations

Branch ID for branch-aware operations

fileNamestring

File name to operate on

File name to operate on

mode'combined' | 'extension' | 'staged' | 'merged' | 'fully-resolved'

IDE mode for YAML operations

IDE mode for YAML operations

string
OR
boolean

Resolve the model extends chain so the returned YAML reflects what runs at query time. Only valid with mode=combined.

includeChecksumsboolean nullable

Include checksums in response

Include checksums in response

includeSchemasstring

A single schema name (optionally catalog-scoped, e.g. 'warehouse.reporting') to additionally load into the response. Use this to include view YAML from a schema that isn't active in the model (inactive or offloaded). Only views from this schema will be returned (views with no schema are always included).

A single schema name (optionally catalog-scoped, e.g. 'warehouse.reporting') to additionally load into the response. Use this to include view YAML from a schema that isn't active in the model (inactive or offloaded). Only views from this schema will be returned (views with no schema are always included).

Response

Model YAML content

checksumsobject

Checksums for each file

filesobject required

YAML content for each file

versionnumber required

Model version number

viewNamesobject

View name mappings