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

# Pull Snowflake Semantic Views into Cube

Pulls Snowflake Semantic Views into a Cube branch and returns a job ID to poll. Generated files are committed to the branch. Requires an API key or OAuth deployment.write token, SQL runner access, and preview enablement.


## OpenAPI

````yaml /api-reference/api.yaml post /api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls
openapi: 3.1.0
info:
  title: Cube Platform API
  version: 1.0.0
  description: >-
    Programmatically manage Cube: deployments and everything scoped to them

    (environments, folders, reports, workbooks, notifications, workspace, and
    agents),

    plus account-level users, groups, policies, embedding, and AI settings.
    Data-model

    authoring, dev mode, branches, and uploads live under /build/api/v1 — same
    host and

    token, routed to the build pods.
servers:
  - url: https://{tenant}.cubecloud.dev
    description: Your tenant host. Replace the whole host if you use a custom domain.
    variables:
      tenant:
        default: your-tenant
        description: Your Cube tenant subdomain
security:
  - bearerAuth: []
tags:
  - name: Deployments
  - name: Deployment Creation
  - name: Environments
  - name: Env Variables
  - name: Regions
  - name: Data Model
  - name: Data Model Uploads
  - name: GitHub
  - name: GitHub Connection
  - name: dbt Sync
  - name: Databricks Metric View Publication
  - name: Databricks Metric View Integration
  - name: Snowflake Semantic View Sync
  - name: Folders
  - name: Reports
  - name: External Documents
  - name: Workbooks
  - name: Workbook Promotions
  - name: Dashboard Exports
  - name: Notifications
  - name: Scheduled Tasks
  - name: Workspace
  - name: Users
  - name: Users Admin
  - name: API Keys
  - name: User Attributes
  - name: User Attribute Values
  - name: Tenant Settings
  - name: OAuth Integrations
  - name: User OAuth Tokens
  - name: OIDC Token Configs
  - name: App Theme
  - name: Embed
  - name: Embed Tenants
  - name: Dashboard Embed Access
  - name: Usage Analytics
  - name: OpenAPI Spec
paths:
  /api/v1/deployments/{deploymentId}/snowflake-semantic-view-pulls:
    post:
      tags:
        - Snowflake Semantic View Sync
      summary: Pull Snowflake Semantic Views into Cube
      operationId: startSnowflakeSemanticViewPull
      parameters:
        - in: path
          name: deploymentId
          required: true
          schema:
            type: integer
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/StartSnowflakeSemanticViewPullInput'
        description: StartSnowflakeSemanticViewPullInput
        required: true
      responses:
        '202':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SnowflakeSemanticViewSyncStartResponse'
          description: ''
components:
  schemas:
    StartSnowflakeSemanticViewPullInput:
      properties:
        branchName:
          oneOf:
            - type: string
            - type: 'null'
          description: Cube branch to write. Defaults to the deployment's deploy branch.
        commitMessage:
          oneOf:
            - type: string
            - type: 'null'
        dataSource:
          oneOf:
            - type: string
            - type: 'null'
        idempotencyKey:
          oneOf:
            - format: uuid
              type: string
            - type: 'null'
          description: >-
            Optional idempotency key. Repeating a pull with the same key and
            inputs returns the original sync.
        namePrefix:
          oneOf:
            - type: string
            - type: 'null'
        outputPath:
          minLength: 1
          type: string
        schema:
          minLength: 1
          type: string
        titlePrefix:
          oneOf:
            - type: string
            - type: 'null'
        viewNames:
          oneOf:
            - items:
                type: string
              type: array
            - type: 'null'
          description: >-
            Semantic view names or * patterns to pull. Omit to pull every view
            in the schema.
      required:
        - schema
        - outputPath
      type: object
    SnowflakeSemanticViewSyncStartResponse:
      properties:
        syncJobId:
          format: uuid
          type: string
        workflowId:
          type: string
      required:
        - syncJobId
        - workflowId
      type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Token authentication. Send `Authorization: Bearer <YOUR_TOKEN>`.'

````