---
title: "Create Workspace"
method: POST
path: "/workspaces"
tags: ["Workspaces"]
---

# Create Workspace

`POST /workspaces`

Creates a new workspace.

This request queues the creation of a workspace. It directly registers an id at the back-end, but the workspace itself may have a status of `provisioning` until the workspace is ready to use.

## Request body

- union
  - object
    - `title` string — A short title for the workspace.
    - `description` string, commonmark — A description that describes the workspace. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.
    - `intent` 'create', required
    - `quota` MaxStorageQuota — unresolved $ref
    - `type` string, nullable — The workspace provider name as defined in `GET /workspace_providers`. If not provided or `null`, the back-end chooses a default provider.
    - `parameters` WorkspaceParameters — Additional parameters to register the workspace as defined in `GET /workspace_providers`. The structure is not specified by the API.
  - object
    - `title` string — A short title for the workspace.
    - `description` string, commonmark — A description that describes the workspace. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation.
    - `intent` 'register', required
    - `quota` MaxStorageQuota — unresolved $ref
    - `type` string, required — The workspace provider name as defined in `GET /workspace_providers`.
    - `url` string, uri, required — The URL of the actual workspace, e.g. a bucket URL.
    - `parameters` WorkspaceParameters, required — Additional parameters to register the workspace as defined in `GET /workspace_providers`. The structure is not specified by the API.

## Response `201`

The workspace creation has been queued successfully.

## Other responses

- `4XX` — unresolved $ref
- `5XX` — unresolved $ref

## Changes

- **2024-10-21** `8bf5938611b2` — 1 breaking
  - the request property `oneOf[#/components/schemas/register_workspace]/parameters` became required
- **2024-09-09** `3b338366e33b` — 1 breaking, 3 info
  - removed `subschema #1: Create workspace, subschema #2: Register existing workspace` from the request body `oneOf` list
  - request body became optional
  - added request discriminator
  - added `#/components/schemas/create_workspace, #/components/schemas/register_workspace` to the request body `oneOf` list
- **2023-12-01** `90d7a6531a39` — 2 info
  - added the new optional request property `description`
  - added the new optional request property `title`
- **2023-10-11** `c3433de805e9` — 2 breaking, 2 warning, 2 info
  - request body became required
  - removed `#/components/schemas/create_workspace, #/components/schemas/register_workspace` from the request body `oneOf` list
  - removed the request property `description`
  - removed the request property `title`
  - …2 more

[Change history](https://skmtc.dev/open-eo/apis/openeo-api-workspaces-extension/changes/workspaces/post.md)

---

[API](https://skmtc.dev/open-eo/apis/openeo-api-workspaces-extension.md) · [All operations](https://skmtc.dev/open-eo/apis/openeo-api-workspaces-extension/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/open-eo/openeo-api-workspaces-extension/revisions/6f92902ecf78/schema)