Snowflake

Snowflake Notebook API

The notebook API from Snowflake — 6 operation(s) for notebook.

GitHub OpenAPI

Operations 11

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/databases/{database}/schemas/{schema}/notebooks List notebooks in a schema · List notebooks #
Ask an LLM
“Which notebooks exist in this schema?”
“Can I see every Snowflake notebook stored in a schema?”
Tell an agent
List all notebooks in schema {schema} of database {database}.
Show me the notebooks stored here.
POST /api/v2/databases/{database}/schemas/{schema}/notebooks Create a notebook · Create a notebook #
Ask an LLM
“How do I create a notebook from a file already sitting in a stage?”
“Can I choose the query warehouse or compute pool a new notebook uses?”
Tell an agent
Create a notebook named {name} in {database}.{schema}.
Create notebook {name} from {fromLocation} with main file {main_file}.
GET /api/v2/databases/{database}/schemas/{schema}/notebooks/{name} Describe a single notebook · Fetch a notebook #
Ask an LLM
“What warehouse, versions and main file does this notebook have?”
“Can I look up the details of one notebook?”
Tell an agent
Describe notebook {name} in {database}.{schema}.
Fetch this notebook's details and versions.
DELETE /api/v2/databases/{database}/schemas/{schema}/notebooks/{name} Delete a notebook · Delete a notebook #
Ask an LLM
“How do I drop a notebook I no longer need?”
“Can a notebook be deleted through the REST API?”
Tell an agent destructive · confirm first
Drop notebook {name} from {database}.{schema}.
Delete the notebook I named.
POST /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:execute Run a notebook · Execute a Notebook #
Ask an LLM
“Can I run a notebook end to end without opening it?”
“Is there a way to execute a notebook from a script or pipeline?”
Tell an agent
Execute notebook {name} in {database}.{schema}.
Run the notebook I named from start to finish.
POST /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:rename Rename or move a notebook · Changes the name of the notebook to new name #
Ask an LLM
“How do I rename a notebook?”
“Can I move a notebook to a different database or schema while renaming it?”
Tell an agent
Rename notebook {database}.{schema}.{name} to {targetName}.
Move this notebook to {targetDatabase}.{targetSchema} as {targetName}.
POST /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:add-live-version Add a LIVE version to a notebook · Adds a LIVE version to the notebook #
Ask an LLM
“Can I create an editable LIVE version of a notebook from its last version?”
“What does adding a live version to a notebook do?”
Tell an agent
Add a LIVE version to notebook {database}.{schema}.{name}.
Add a LIVE version based on the last version ({fromLast}) with comment {comment}.
POST /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:commit Commit a notebook's LIVE version · Commits the LIVE version of the notebook #
Ask an LLM
“How do I commit my notebook changes to its connected Git repository?”
“Can I name the version and add a message when committing a notebook?”
Tell an agent
Commit the LIVE version of notebook {database}.{schema}.{name}.
Commit this notebook as version {version} with message {comment}.
POST /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:set-tags Set tags on a notebook · Set tags on a notebook #
Ask an LLM
“How do I tag a notebook?”
“Can I label a notebook with a project tag?”
Tell an agent
Set tags on notebook {database}.{schema}.{name}.
Apply my tag assignments to the notebook I named.
POST /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:unset-tags Remove tags from a notebook · Unset tags from a notebook #
Ask an LLM
“Can I remove tags from a notebook?”
“What's the way to clear a tag off a notebook?”
Tell an agent
Unset the tags on notebook {database}.{schema}.{name}.
Remove the tag assignments from the notebook I named.
GET /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:get-tags Get the tags assigned to a notebook · Get the tag assignments for a notebook #
Ask an LLM
“Which tags are assigned to this notebook?”
“Does reading a notebook's tags need an active warehouse?”
Tell an agent
Show every tag assigned to notebook {database}.{schema}.{name}.
List the tag assignments on the notebook I named.

Documentation

📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/account
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/alert
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/api-integration
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/catalog-integration
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/compute-pool
📖
Documentation
https://docs.snowflake.com/en/user-guide/snowflake-cortex/cortex-analyst/rest-api
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/cortex-inference
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/cortex-search-service
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/database-role
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/database
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/dynamic-table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/event-table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/external-volume
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/function
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/grant
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/iceberg-table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/image-repository
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/managed-account
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/network-policy
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/notebook
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/notification-integration
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/pipe
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/procedure
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/result
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/role
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/schema
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/service
📖
Documentation
https://docs.snowflake.com/en/developer-guide/sql-api/index
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/stage
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/stream
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/table
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/task
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/user-defined-function
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/user
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/view
📖
Documentation
https://docs.snowflake.com/en/developer-guide/snowflake-rest-api/reference/warehouse

Specifications

⚙
OpenAPI
https://artifacts.apis.io/snowflake/openapi/snowflake-notebook-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/snowflake/json-schema/snowflake-database-schema.json
📊
JSONSchema
https://artifacts.apis.io/snowflake/json-schema/snowflake-warehouse-schema.json

Other Resources

🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/account-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/alert-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/api-integration-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/catalog-integration-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/compute-pool-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/cortex-analyst-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/cortex-inference-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/cortex-search-service-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/database-role-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/database-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/dynamic-table-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/event-table-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/external-volume-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/function-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/grant-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/iceberg-table-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/image-repository-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/managed-account-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/network-policy-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/notebook-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/notification-integration-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/pipe-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/procedure-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/role-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/schema-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/service-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/sqlapi-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/snowflake-sql-rest-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/stage-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/stream-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/table-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/task-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/user-defined-function-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/user-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/view-context.jsonld
🔗
JSONLD
https://artifacts.apis.io/snowflake/json-ld/warehouse-context.jsonld
🔗
Overlay
https://artifacts.apis.io/snowflake/overlays/snowflake-notebook-overlay.yaml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/snowflake:snowflake-notebook-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

snowflake-notebook-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  version: 0.0.1
  title: Snowflake Notebook API
  description: The Snowflake Notebook API is a REST API that you can use to access, update, and perform certain actions on Notebook resource in a Snowflake database.
  contact:
    name: Snowflake, Inc.
    url: https://snowflake.com
    email: support@snowflake.com
servers:
- description: Snowflake REST Server
  url: https://org-account.snowflakecomputing.com
security:
- KeyPair: []
- ExternalOAuth: []
- SnowflakeOAuth: []
- ProgrammaticAccessToken: []
tags:
- name: Notebook
paths:
  /api/v2/databases/{database}/schemas/{schema}/notebooks:
    get:
      summary: List notebooks
      tags:
      - Notebook
      operationId: listNotebooks
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/like
      - $ref: common.yaml#/components/parameters/startsWith
      - $ref: common.yaml#/components/parameters/showLimit
      - $ref: common.yaml#/components/parameters/fromName
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Notebook'
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
    post:
      summary: Create a notebook
      tags:
      - Notebook
      operationId: createNotebook
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/createMode
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Notebook'
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:
    get:
      summary: Fetch a notebook
      tags:
      - Notebook
      operationId: fetchNotebook
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Notebook'
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
    delete:
      summary: Delete a notebook
      tags:
      - Notebook
      operationId: deleteNotebook
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:execute:
    post:
      summary: Execute a Notebook
      tags:
      - Notebook
      operationId: executeNotebook
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/asyncExec
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:rename:
    post:
      summary: Changes the name of the notebook to new name
      tags:
      - Notebook
      description: Changes the name of the notebook to new name. The new identifier must be unique for the schema.
      operationId: renameNotebook
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      - name: targetDatabase
        description: Database of the target resource. Defaults to the source's database
        in: query
        required: false
        schema:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
      - name: targetSchema
        description: Schema of the target resource. Defaults to the source's schema
        in: query
        required: false
        schema:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
      - name: targetName
        description: Name of the target resource.
        in: query
        required: true
        schema:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:add-live-version:
    post:
      summary: Adds a LIVE version to the notebook
      tags:
      - Notebook
      operationId: addLiveVersionNotebook
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - name: fromLast
        description: Sets the LIVE version to the LAST version of the notebook
        in: query
        required: false
        schema:
          type: boolean
      - name: comment
        description: Sets a comment for the notebook or version of the notebook
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:commit:
    post:
      summary: Commits the LIVE version of the notebook
      tags:
      - Notebook
      description: If a Git connection is set up for the notebook, commits the LIVE version of the notebook to the Git repository
      operationId: commitNotebook
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - name: version
        description: live version of the alias
        in: query
        required: false
        schema:
          type: string
      - name: comment
        description: Sets a comment for the notebook or version of the notebook
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:set-tags:
    post:
      summary: Set tags on a notebook
      tags:
      - Notebook
      description: Set tags on a notebook.
      operationId: setTags
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: common.yaml#/components/schemas/TagAssignment
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:unset-tags:
    post:
      summary: Unset tags from a notebook
      tags:
      - Notebook
      description: Unset tags from a notebook.
      operationId: unsetTags
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/ifExists
      responses:
        '200':
          $ref: common.yaml#/components/responses/200SuccessResponse
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: common.yaml#/components/schemas/TagReference
  /api/v2/databases/{database}/schemas/{schema}/notebooks/{name}:get-tags:
    get:
      summary: Get the tag assignments for a notebook
      tags:
      - Notebook
      description: Returns all tags assigned to a notebook. This operation requires an active warehouse.
      operationId: getTags
      parameters:
      - $ref: common.yaml#/components/parameters/database
      - $ref: common.yaml#/components/parameters/schema
      - $ref: common.yaml#/components/parameters/name
      - $ref: common.yaml#/components/parameters/withLineage
      responses:
        '200':
          description: successful
          headers:
            X-Snowflake-Request-ID:
              $ref: common.yaml#/components/headers/X-Snowflake-Request-ID
            Link:
              $ref: common.yaml#/components/headers/Link
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: common.yaml#/components/schemas/TagAssignment
        '202':
          $ref: common.yaml#/components/responses/202SuccessAcceptedResponse
        '400':
          $ref: common.yaml#/components/responses/400BadRequest
        '401':
          $ref: common.yaml#/components/responses/401Unauthorized
        '403':
          $ref: common.yaml#/components/responses/403Forbidden
        '404':
          $ref: common.yaml#/components/responses/404NotFound
        '405':
          $ref: common.yaml#/components/responses/405MethodNotAllowed
        '408':
          $ref: common.yaml#/components/responses/408RequestTimeout
        '409':
          $ref: common.yaml#/components/responses/409Conflict
        '410':
          $ref: common.yaml#/components/responses/410Gone
        '429':
          $ref: common.yaml#/components/responses/429LimitExceeded
        '500':
          $ref: common.yaml#/components/responses/500InternalServerError
        '503':
          $ref: common.yaml#/components/responses/503ServiceUnavailable
        '504':
          $ref: common.yaml#/components/responses/504GatewayTimeout
components:
  schemas:
    VersionDetails:
      type: object
      description: The version details of a file based entity
      properties:
        name:
          type: string
          readOnly: true
          description: The last version name
        alias:
          type: string
          readOnly: true
          description: The default/last version alias of a file based entity.
        location_url:
          type: string
          readOnly: true
          description: The default/last version location.
        source_location_uri:
          type: string
          readOnly: true
          description: The default/last version source location.
        git_commit_hash:
          type: string
          readOnly: true
          description: The default/last version git commit#
    Notebook:
      type: object
      description: A Snowflake notebook
      properties:
        name:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          description: Name of the Notebook
        version:
          type: string
          description: User specified version alias
        fromLocation:
          type: string
          description: Location to copy the file from. This must be a Snowflake stage location.
        main_file:
          type: string
          description: Name + path of the file for the Notebook
        comment:
          type: string
          description: user comment associated to an object in the dictionary
        default_version:
          type: string
          description: The default version name of a file based entity.
        query_warehouse:
          type: string
          description: Warehouse against which the queries issued by the Notebook app are run against
        created_on:
          type: string
          format: date-time
          readOnly: true
          description: Date and time when the Notebook was created.
        database_name:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          readOnly: true
          description: Database in which the Notebook is stored
        schema_name:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          readOnly: true
          description: Schema in which the Notebook is stored
        owner:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          readOnly: true
          description: Role that owns the Notebook
        owner_role_type:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          readOnly: true
          description: The type of role that owns the Notebook
        url_id:
          type: string
          readOnly: true
          description: A unique ID associated with the Notebook object's URL.
        title:
          type: string
          description: User facing title of the Notebook app
        default_packages:
          type: string
          readOnly: true
          description: Default packages for Notebook apps.
        user_packages:
          type: string
          readOnly: true
          description: User packages of the Notebook
        runtime_name:
          type: string
          description: The runtime to run the Notebook on. If this is not set, the Warehouse Runtime is assumed
        compute_pool:
          type: string
          description: Compute pool name where the Notebook runs. Required when runtime_name is set to SYSTEM$BASIC_RUNTIME or SYSTEM$GPU_RUNTIME
        import_urls:
          type: array
          items:
            type: string
          description: List of files to be imported from a stage.
        external_access_integrations:
          type: array
          items:
            type: string
          description: List of external access integrations attached to this Notebook
        external_access_secrets:
          type: string
          readOnly: true
          description: Secrets to be used with this function for external access
        idle_auto_shutdown_time_seconds:
          type: integer
          format: int64
          description: Sets the time in seconds for when to shutdown an idle Notebook.
        default_version_details:
          $ref: '#/components/schemas/VersionDetails'
          readOnly: true
        last_version_details:
          $ref: '#/components/schemas/VersionDetails'
          readOnly: true
        live_version_location_uri:
          type: string
          readOnly: true
          description: The current version location
        budget:
          type: string
          pattern: ^"([^"]|"")+"|[a-zA-Z_][a-zA-Z0-9_$]*$
          readOnly: true
          description: Name of the budget if the Notebook is monitored by a budget
      required:
      - name
  securitySchemes:
    KeyPair:
      $ref: common.yaml#/components/securitySchemes/KeyPair
    ExternalOAuth:
      $ref: common.yaml#/components/securitySchemes/ExternalOAuth
    SnowflakeOAuth:
      $ref: common.yaml#/components/securitySchemes/SnowflakeOAuth
    ProgrammaticAccessToken:
      $ref: common.yaml#/components/securitySchemes/ProgrammaticAccessToken