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

# Create a workspace

`POST /workspaces`

## Request

- Base URL: `https://api.vidmoat.com/v1`
- URL: `https://api.vidmoat.com/v1/workspaces`
- Auth: HTTP bearer

Create a workspace. Pass teamId to make it a shared one.

## Request body

- object
  - `name` string, required: Up to 48 characters.
  - `color` string: One of `#FF4D2E`, `#5AA9FF`, `#7ED9A6`, `#FFD447`, `#A855F7`, `#FF7A5A`, `#9EDCC4`, `#94A3B8`. Any other value is stored as `null`.
  - `icon` string: One emoji (at most two code points). Longer is stored as `null`.
  - `teamId` string: A team you belong to, for a shared workspace.

## Response `201`

Create a workspace

- object
  - `id` string: The workspace id.
  - `name` string: Its name.
  - `color` string, nullable: A hex colour, or `null` when none is set.
  - `icon` string, nullable: An emoji, or `null`.
  - `teamId` string, nullable: The team it belongs to, or `null` for a personal workspace.
  - `projectCount` integer: Projects filed in it (0 for a new one).

## Other responses

- `400`: `invalid_request`: No name, a team you are not in, or you already have 60 workspaces.

---

[API](https://skmtc.dev/vidmoat/apis/vidmoat-api.md) · [All operations](https://skmtc.dev/vidmoat/apis/vidmoat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vidmoat/apis/vidmoat-api/revisions/23e24e25c756?raw)