> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Snowflake: Actions/get Semantic Layer

> Read your organization's Snowflake semantic layer: the defined metrics, dimensions and tables, before asking a business question.

Read your organization's Snowflake semantic layer: the defined metrics, dimensions and tables, before asking a business question.

> [!NOTE]
>
> Tool ID: `snowflake_get_semantic_layer`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'snowflake_get_semantic_layer',
  {
    "includeYaml": true
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute snowflake_get_semantic_layer --input '{
  "includeYaml": true
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "configured": true,
    "source": "customer_db",
    "provider": "snowflake",
    "contentHash": "example",
    "updatedAt": "2026-01-15T12:00:00Z",
    "tableCount": 123,
    "tables": [
      "example"
    ]
  }
}
```

Use `deepline describe snowflake_get_semantic_layer --json` for the latest machine-readable contract.

## Input reference

Read the active Snowflake semantic layer for the organization.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.includeYaml` | `boolean` | No | `true` | Whether to include the full semantic layer YAML. Default true. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Read the active Snowflake semantic layer for the organization.",
    "properties": {
      "includeYaml": {
        "type": "boolean",
        "description": "Whether to include the full semantic layer YAML. Default true.",
        "default": true
      }
    },
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Snowflake semantic layer document.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Semantic layer payload. |
| `result.data.configured` | `boolean` | Yes | — | — |
| `result.data.source` | `"customer_db"` | Yes | — | Allowed: `customer_db`. |
| `result.data.provider` | `"snowflake"` | Yes | — | — |
| `result.data.contentHash` | `string \| null` | Yes | — | — |
| `result.data.updatedAt` | `string \| null` | Yes | — | — |
| `result.data.tableCount` | `integer` | Yes | — | — |
| `result.data.tables` | `array` | Yes | — | — |
| `result.data.yaml` | `string` | No | — | — |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Snowflake semantic layer document.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Semantic layer payload.",
        "properties": {
          "configured": {
            "type": "boolean"
          },
          "source": {
            "type": [
              "string",
              "null"
            ],
            "enum": [
              "customer_db"
            ]
          },
          "provider": {
            "type": "string",
            "const": "snowflake"
          },
          "contentHash": {
            "type": [
              "string",
              "null"
            ]
          },
          "updatedAt": {
            "type": [
              "string",
              "null"
            ]
          },
          "tableCount": {
            "type": "integer"
          },
          "tables": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "yaml": {
            "type": "string"
          }
        },
        "required": [
          "configured",
          "source",
          "provider",
          "contentHash",
          "updatedAt",
          "tableCount",
          "tables"
        ],
        "additionalProperties": false
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Snowflake provider guide](https://deepline.com/docs/providers/snowflake/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.