---
title: "Get model YAML"
method: GET
path: "/api/v1/models/{modelId}/yaml"
tags: ["Models"]
---

# Get model YAML

`GET /api/v1/models/{modelId}/yaml`

## Path parameters

- `modelId` string, uuid, required — Model UUID

## Query parameters

- `branchId` string, uuid — Branch ID for branch-aware operations
- `fileName` string — File name to operate on
- `mode` 'combined' | 'extension' | 'staged' | 'merged' | 'fully-resolved' — IDE mode for YAML operations
- `fullyResolved` union — Resolve the model extends chain so the returned YAML reflects what runs at query time. Only valid with mode=combined.
  - string
  - boolean
- `includeChecksums` boolean, nullable — Include checksums in response
- `includeSchemas` string — 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 `200`

Model YAML content

- ModelYamlResponse
  - `checksums` object — Checksums for each file
  - `files` object, required — YAML content for each file
  - `version` number, required — Model version number
  - `viewNames` object — Mapping of file name to view name

## Other responses

- `401` — Authentication required
- `403` — Permission denied
- `404` — Model not found

---

[API](https://skmtc.net/omniapp/apis/omni-api.md) · [All operations](https://skmtc.net/omniapp/apis/omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/omniapp/omni-api/versions/4701f292c621/schema)