Create a workspace

Módulo Settings

POST/workspacesworkspaces.create

A workspace inside an organization. Creates a workspace. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad org.workspaces.manage.
Alcances de OAuth: org.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: WorkspaceCreate

workspaces.create: WorkspaceCreate
Campo	Tipo	Obligatorio	Descripción
name	string	Sí	Workspace name.Restricciones: length 1 to 300
slug	string	Sí	URL slug.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "name": "Festivals",
  "slug": "festivals"
}

Respuesta 201: Workspace

workspaces.create: Workspace
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the workspace.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Sí	Workspace name.Restricciones: length 1 to 300
slug	string	Sí	URL slug.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Festivals",
  "slug": "festivals"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/workspaces" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Festivals","slug":"festivals"}'

const { data } = await xos.workspaces.create({
    "name": "Festivals",
    "slug": "festivals"
  });

response = xos.workspaces.create({"name": "Festivals", "slug": "festivals"})

xos workspaces create --data '{"name":"Festivals","slug":"festivals"}'