v1

latestOpenAPI 3.1.02026-07-2618690613.4 KB
Models

Get model YAML

Retrieve the YAML representation of a model with optional filtering and mode selection.

get/v1/models/{modelId}/yaml

Path parameters

modelIdstring uuid required

The unique identifier of the model.

Query parameters

branchIdstring uuid

The ID of the branch to retrieve YAML from. Only valid for shared models in combined mode. To retrieve branch IDs, use the List models endpoint with modelKind=BRANCH.

fileNamestring

Filter YAML files by name. Can be a string or a regex pattern.

mode'extension' | 'staged' | 'combined'

The mode to use when retrieving YAML.

  • extension - Returns extension-only format
  • staged - Returns staged changes
  • combined - Returns combined YAML
includeChecksumsboolean

If true, the response will include file checksums for concurrency control.

A file's checksum can be passed as a query parameter in the Create or update YAML endpoint to ensure changes made by another user aren't overwritten.

includeSchemasstring

Filters the returned YAML to only include views from the specified schema. Relationships are preserved even if they reference views outside the specified schema.

This parameter accepts a single schema name only. Use the List model schemas endpoint to discover available schema names.

fullyResolvedboolean

If true, returns YAML with any extensions (extends) resolved. This will match what runs at query time.

When false (default), returns the YAML as authored in the model files. This means even if extensions are used, they will not be included in the returned YAML.

Response

Model YAML specification

filesobject

Map of file paths to YAML content.

versioninteger

Version of the YAML.

viewNamesobject

Map of view names to their definitions.

checksumsobject

Map of file paths to their checksums.