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

# Create notebook

> create notebook. POST /api/v1/notebooks. Uses the same payload, validation, revision checks and response as the unified HTTP API.

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json POST /api/v1/notebooks
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/notebooks:
    post:
      tags:
        - Notebooks
      summary: create notebook
      description: >-
        create notebook. POST /api/v1/notebooks. Uses the same payload,
        validation, revision checks and response as the unified HTTP API.
      operationId: create_notebook
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Input_app_notebooks_core_src_models_rs_NotebookCreateRequest
        required: true
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/app_notebooks_core_src_models_rs_NotebookResponse
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    Input_app_notebooks_core_src_models_rs_NotebookCreateRequest:
      properties:
        document:
          description: JSON value; fields depend on the enclosing document or provider.
        name:
          type: string
        settings:
          $ref: >-
            #/components/schemas/Input_app_notebooks_core_src_models_rs_NotebookSettings
        submission_id:
          $ref: '#/components/schemas/Input_shared_common_src_lib_rs_SubmissionId'
      required:
        - submission_id
        - name
        - document
      type: object
    app_notebooks_core_src_models_rs_NotebookResponse:
      properties:
        notebook:
          $ref: >-
            #/components/schemas/app_notebooks_core_src_models_rs_NotebookSnapshot
      required:
        - notebook
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    Input_app_notebooks_core_src_models_rs_NotebookSettings:
      additionalProperties: false
      properties:
        options:
          $ref: >-
            #/components/schemas/Input_shared_common_src_lib_rs_WorkloadSubmissionOptions
        query:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_QuerySettings
            - type: 'null'
          description: Omitted query settings use the engine's configured session defaults.
      required: []
      type: object
    Input_shared_common_src_lib_rs_SubmissionId:
      format: uuid
      type: string
    app_notebooks_core_src_models_rs_NotebookSnapshot:
      properties:
        created_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
        document:
          description: JSON value; fields depend on the enclosing document or provider.
        name:
          type: string
        notebook_id:
          $ref: '#/components/schemas/app_notebooks_core_src_models_rs_NotebookId'
        revision:
          minimum: 0
          type: integer
        settings:
          $ref: >-
            #/components/schemas/app_notebooks_core_src_models_rs_NotebookSettings
        updated_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
      required:
        - notebook_id
        - name
        - revision
        - document
        - settings
        - created_at
        - updated_at
      type: object
    Input_shared_common_src_lib_rs_WorkloadSubmissionOptions:
      properties:
        compute_requirements:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_ComputeRequirements
            - type: 'null'
        deployment_profile:
          anyOf:
            - type: string
            - type: 'null'
        execution_target:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_ExecutionTarget
            - type: 'null'
        execution_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        max_attempts:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        missed_run_policy:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_MissedRunPolicy
            - type: 'null'
        overlap_policy:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_lib_rs_OverlapPolicy
            - type: 'null'
        parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
          description: Maximum assigned tasks in one run. Unset has no run limit.
        profile:
          anyOf:
            - type: string
            - type: 'null'
        provisioner:
          anyOf:
            - type: string
            - type: 'null'
        queue_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        start_paused:
          type: boolean
        worker_scope:
          anyOf:
            - $ref: '#/components/schemas/Input_shared_common_src_lib_rs_WorkerScope'
            - type: 'null'
        xray:
          type: boolean
      required: []
      type: object
    Input_shared_common_src_lib_rs_QuerySettings:
      properties:
        ansi_enabled:
          type: boolean
        case_sensitive:
          type: boolean
        current_catalog:
          type: string
        namespace:
          items:
            type: string
          type: array
        time_zone:
          type: string
      required:
        - current_catalog
        - namespace
        - time_zone
        - case_sensitive
        - ansi_enabled
      type: object
    shared_common_src_time_rs_WallClockTimestamp:
      properties:
        unix_millis:
          type: integer
      required:
        - unix_millis
      type: object
    app_notebooks_core_src_models_rs_NotebookId:
      format: uuid
      type: string
    app_notebooks_core_src_models_rs_NotebookSettings:
      properties:
        options:
          $ref: >-
            #/components/schemas/shared_common_src_lib_rs_WorkloadSubmissionOptions
        query:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_QuerySettings'
            - type: 'null'
          description: Omitted query settings use the engine's configured session defaults.
      required:
        - query
        - options
      type: object
    Input_shared_common_src_lib_rs_ComputeRequirements:
      properties:
        cpu_millicores:
          minimum: 1
          type: integer
        memory_bytes:
          minimum: 1
          type: integer
        tuning:
          anyOf:
            - $ref: >-
                #/components/schemas/Input_shared_common_src_compute_rs_ComputeTuning
            - type: 'null'
      required:
        - cpu_millicores
        - memory_bytes
      type: object
    Input_shared_common_src_lib_rs_ExecutionTarget:
      oneOf:
        - const: DataFusion
          type: string
        - const: DuckDb
          type: string
    Input_shared_common_src_lib_rs_MissedRunPolicy:
      oneOf:
        - const: RunOnce
          type: string
        - const: RunAll
          type: string
        - const: Skip
          type: string
    Input_shared_common_src_lib_rs_OverlapPolicy:
      oneOf:
        - const: Wait
          type: string
        - const: Skip
          type: string
        - const: Allow
          type: string
    Input_shared_common_src_lib_rs_WorkerScope:
      oneOf:
        - const: Task
          type: string
        - const: Workload
          type: string
        - const: Deployment
          type: string
    shared_common_src_lib_rs_WorkloadSubmissionOptions:
      properties:
        compute_requirements:
          anyOf:
            - $ref: >-
                #/components/schemas/shared_common_src_lib_rs_ComputeRequirements
            - type: 'null'
        deployment_profile:
          anyOf:
            - type: string
            - type: 'null'
        execution_target:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_ExecutionTarget'
            - type: 'null'
        execution_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        max_attempts:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        missed_run_policy:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_MissedRunPolicy'
            - type: 'null'
        overlap_policy:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_OverlapPolicy'
            - type: 'null'
        parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
          description: Maximum assigned tasks in one run. Unset has no run limit.
        profile:
          anyOf:
            - type: string
            - type: 'null'
        provisioner:
          anyOf:
            - type: string
            - type: 'null'
        queue_timeout:
          anyOf:
            - properties:
                nanos:
                  maximum: 999999999
                  minimum: 0
                  type: integer
                secs:
                  minimum: 0
                  type: integer
              required:
                - secs
                - nanos
              type: object
            - type: 'null'
        start_paused:
          type: boolean
        worker_scope:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_lib_rs_WorkerScope'
            - type: 'null'
        xray:
          type: boolean
      required:
        - queue_timeout
        - worker_scope
        - parallelism
        - execution_target
        - execution_timeout
        - compute_requirements
        - max_attempts
        - missed_run_policy
        - overlap_policy
      type: object
    shared_common_src_lib_rs_QuerySettings:
      properties:
        ansi_enabled:
          type: boolean
        case_sensitive:
          type: boolean
        current_catalog:
          type: string
        namespace:
          items:
            type: string
          type: array
        time_zone:
          type: string
      required:
        - current_catalog
        - namespace
        - time_zone
        - case_sensitive
        - ansi_enabled
      type: object
    Input_shared_common_src_compute_rs_ComputeTuning:
      additionalProperties: false
      properties:
        batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        file_read_concurrency:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        input_prefetch_batches:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        native_parquet_scan:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            False always uses connector-produced Arrow batches. Omitted keeps
            the native Parquet capability enabled when the source can supply it
            safely.
        output_buffer_batches:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        query_memory_bytes:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        spill_bytes:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: >-
            Zero disables disk spill. The directory is controlled by the
            deployment.
        threads:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
      required: []
      type: object
    shared_common_src_lib_rs_ComputeRequirements:
      properties:
        cpu_millicores:
          minimum: 1
          type: integer
        memory_bytes:
          minimum: 1
          type: integer
        tuning:
          anyOf:
            - $ref: '#/components/schemas/shared_common_src_compute_rs_ComputeTuning'
            - type: 'null'
      required:
        - cpu_millicores
        - memory_bytes
      type: object
    shared_common_src_lib_rs_ExecutionTarget:
      oneOf:
        - const: DataFusion
          type: string
        - const: DuckDb
          type: string
    shared_common_src_lib_rs_MissedRunPolicy:
      oneOf:
        - const: RunOnce
          type: string
        - const: RunAll
          type: string
        - const: Skip
          type: string
    shared_common_src_lib_rs_OverlapPolicy:
      oneOf:
        - const: Wait
          type: string
        - const: Skip
          type: string
        - const: Allow
          type: string
    shared_common_src_lib_rs_WorkerScope:
      oneOf:
        - const: Task
          type: string
        - const: Workload
          type: string
        - const: Deployment
          type: string
    shared_common_src_compute_rs_ComputeTuning:
      properties:
        batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        file_read_concurrency:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        input_prefetch_batches:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
        native_parquet_scan:
          anyOf:
            - type: boolean
            - type: 'null'
          description: >-
            False always uses connector-produced Arrow batches. Omitted keeps
            the native Parquet capability enabled when the source can supply it
            safely.
        output_buffer_batches:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        query_memory_bytes:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        spill_bytes:
          anyOf:
            - minimum: 0
              type: integer
            - type: 'null'
          description: >-
            Zero disables disk spill. The directory is controlled by the
            deployment.
        threads:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_batch_rows:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
        write_parallelism:
          anyOf:
            - minimum: 1
              type: integer
            - type: 'null'
      required:
        - threads
        - query_memory_bytes
        - batch_rows
        - write_batch_rows
        - write_parallelism
        - spill_bytes
        - output_buffer_batches
        - file_read_concurrency
        - input_prefetch_batches
      type: object

````

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