Skip to content
Documentation/API reference
API · workspaces

Create workspace

POST /api/v2/workspaces

Authorization

Authenticated user session (use inboxit login). Use the CLI login flow; a workspace API key cannot call this operation.

Parameters

All resource access is checked against the selected workspace and user permissions.

NameTypeContract
namestring · requiredTrimmed 1–10 characters

Request

Run inboxit login first. The CLI supplies authenticated user credentials.

Example
inboxit workspaces create --data @request.json

JSON body

Save this JSON as request.json for the request above. Replace example values with your own.

Example
{
  "name": "prod"
}

Response

HTTP 201. Example values are illustrative; excerpts are marked.

Example
{
  "id": "WORKSPACE_UUID",
  "name": "prod",
  "created_at": "2026-10-23T12:00:00Z"
}

Behavior & errors

Maximum 20 owned workspaces. Account quotas are shared, not reset by creating a workspace. Common errors: 400 invalid input, 401 unauthenticated, 403 insufficient permission, 404 missing/inaccessible resource, 409 conflict, 429 rate/usage limit, 503 service unavailable. See Errors & retries for recovery guidance.