Create New Workspace

POST

/v1/workspaces

Create a new workspace for the authenticated user.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Example

{
    "name": "New Project Workspace",
    "description": "Workspace for new project team"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location '/v1/workspaces' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "New Project Workspace",
    "description": "Workspace for new project team"
}'

Responses

🟢201

application/json

Workspace created successfully

Bodyapplication/json

Example

{
    "status": 201,
    "message": "Workspace created successfully",
    "data": {
        "id": "wks3",
        "name": "New Project Workspace",
        "description": "Workspace for new project team",
        "createdAt": "2025-10-04T12:00:00Z"
    }
}

Retrieve All Workspaces

Update Workspace