Sign inGet Started

Create a workspace

POST
/v1/organization/workspaces
const workspace = await bird.organization.workspaces.create({
  name: "Staging",
});
console.log(workspace.id);
Resposta201
{
  "id": "ws_01krdgeqcxet5s7t44vh8rt9mg",
  "organization_id": "org_01krdgeqcxet5s7t44vh8rt9mg",
  "name": "Production",
  "notification_emails": {
    "operational": [
      "alerts@example.com"
    ]
  },
  "created_at": "2026-05-20T09:14:52Z",
  "updated_at": "2026-05-25T16:42:01Z"
}

Creates a workspace in the caller's organization. The caller needs organization workspace write access, which organization master keys and signed-in organization owners and administrators have, as do CLI or MCP access tokens they authorize with that access. Workspace API keys cannot create workspaces. The organization's workspace limit counts every workspace it holds, including workspaces awaiting permanent deletion, and a request beyond the limit fails with E10014.

Corpo da requisição

name
string
obrigatório

Must include at least one letter or number.

Payload de resposta

id
string
obrigatório
organization_id
string
obrigatório
name
string
obrigatório
notification_emails
object
obrigatório
Mostrar atributos secundários
logo_url
nullable string

HTTPS URL to the current workspace logo. null when unset.

created_at
string
obrigatório
updated_at
string
obrigatório