---
title: "Create workspace"
method: POST
path: "/workspaces/{namespace}"
tags: ["workspaces"]
---

# Create workspace

`POST /workspaces/{namespace}`

Creates a new workspace in the specified namespace.

## Path parameters

- `namespace` string, required

## Request body

- ApiWorkspaceCreateEnvelope
  - `data` WorkspacesWorkspaceCreate, required
    - `kind` string, required
    - `name` string, required
    - `paused` boolean, required
    - `podTemplate` WorkspacesPodTemplateMutate, required
      - `options` WorkspacesPodTemplateOptionsMutate, required
        - `imageConfig` string, required
        - `podConfig` string, required
      - `podMetadata` WorkspacesPodMetadataMutate, required
        - `annotations` object, required
        - `labels` object, required
      - `volumes` WorkspacesPodVolumesMutate, required
        - `data` WorkspacesPodVolumeMount[], required
          - `mountPath` string, required
          - `pvcName` string, required
          - `readOnly` boolean
        - `home` string
        - `secrets` WorkspacesPodSecretMount[]
          - `defaultMode` integer
          - `mountPath` string, required
          - `secretName` string, required

## Response `201`

Workspace created successfully

- ApiWorkspaceCreateEnvelope
  - `data` WorkspacesWorkspaceCreate, required
    - `kind` string, required
    - `name` string, required
    - `paused` boolean, required
    - `podTemplate` WorkspacesPodTemplateMutate, required
      - `options` WorkspacesPodTemplateOptionsMutate, required
        - `imageConfig` string, required
        - `podConfig` string, required
      - `podMetadata` WorkspacesPodMetadataMutate, required
        - `annotations` object, required
        - `labels` object, required
      - `volumes` WorkspacesPodVolumesMutate, required
        - `data` WorkspacesPodVolumeMount[], required
          - `mountPath` string, required
          - `pvcName` string, required
          - `readOnly` boolean
        - `home` string
        - `secrets` WorkspacesPodSecretMount[]
          - `defaultMode` integer
          - `mountPath` string, required
          - `secretName` string, required

## Other responses

- `400` — Bad Request.
- `401` — Unauthorized. Authentication is required.
- `403` — Forbidden. User does not have permission to create workspace.
- `409` — Conflict. Workspace with the same name already exists.
- `413` — Request Entity Too Large. The request body is too large.
- `415` — Unsupported Media Type. Content-Type header is not correct.
- `422` — Unprocessable Entity. Validation error.
- `500` — Internal server error. An unexpected error occurred on the server.

---

[API](https://skmtc.net/opendatahub-io/apis/kubeflow-notebooks-api.md) · [All operations](https://skmtc.net/opendatahub-io/apis/kubeflow-notebooks-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/opendatahub-io/kubeflow-notebooks-api/versions/257ea068094f/schema)