---
title: "Create a Notebook in the given Namesapce"
method: POST
path: "/aide/v1/namespaces/{namespace}/notebooks"
---

# Create a Notebook in the given Namesapce

`POST /aide/v1/namespaces/{namespace}/notebooks`

Post Notebooks.

## Path parameters

- `namespace` string, string, required

## Request body

- NewNotebookRequest
  - `name` string, required — Notebook name
  - `namespace` string, required — Kubernetes Namespace where notebook will be created
  - `proxyUser` string — Proxy User of Notebook.
  - `image` Image, required
    - `imageType` 'Standard' | 'Custom' — Docker Image Type (default: Standard)
    - `imageName` string, required — Docker Image Name
  - `cpu` number, double, required — Specify the total amount of CPU reserved by user's Notebook. For CPU-Intensive workloads,user can choose more than 1 CPU (e.g 1.5)
  - `memory` Memory, required
    - `memoryAmount` number, double, required — Amount of memory required
    - `memoryUnit` 'Mi' | 'M' | 'Gi' | 'G' — Memory unit (default: Mi)
  - `workspaceVolume` MountInfo
    - `mountType` 'New' | 'Existing' | 'None', required — Mount type
    - `localPath` string, required — Local Path or Kubernetes PV/PVC
    - `subPath` string — subPath of localpath
    - `size` integer, required — Storage capacity
    - `mountPath` string, required — Container path
    - `accessMode` 'ReadWriteOnce' | 'ReadWriteMany' | 'ReadOnlyMany' — Data access mode
  - `dataVolume` MountInfo
    - `mountType` 'New' | 'Existing' | 'None', required — Mount type
    - `localPath` string, required — Local Path or Kubernetes PV/PVC
    - `subPath` string — subPath of localpath
    - `size` integer, required — Storage capacity
    - `mountPath` string, required — Container path
    - `accessMode` 'ReadWriteOnce' | 'ReadWriteMany' | 'ReadOnlyMany' — Data access mode
  - `extraResources` string — Reserve additional resources,for example, to reserve 2 GPUs: {"nvidia.com/gup": 2}
  - `queue` string — BDAP Yarn Queue Setting
  - `executorCores` string — User excutor core setting in BDAP Yarn Cluster
  - `executorMemory` string — User excutor memory setting in BDAP Yarn Cluster
  - `executors` string — User excutors setting in BDAP Yarn Cluster
  - `driverMemory` string — User driver memory in BDAP Yarn Cluster
  - `sparkSessionNum` number — The number of spark session

## Response `200`

OK

## Other responses

- `401` — Unauthorized
- `404` — Notebook create failed

---

[API](https://skmtc.net/webankfintech/apis/jupyter-server.md) · [All operations](https://skmtc.net/webankfintech/apis/jupyter-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/webankfintech/jupyter-server/versions/96d3198b3b53/schema)