Workspaces API

Endpoints

GET/workspacesList workspaces for current user

POST/workspacesCreate a workspace

GET/workspaces/:idGet workspace details

PATCH/workspaces/:idUpdate workspace settings

GET/workspaces/:id/membersList members

POST/workspaces/:id/invitationsInvite a member

PATCH/workspaces/:id/members/:uidUpdate a member's role

DELETE/workspaces/:id/members/:uidRemove a member

GET/workspaces/:id/api-keysList API keys

POST/workspaces/:id/api-keysCreate an API key

DELETE/api-keys/:idRevoke an API key

GET/workspaces/:id/usageGet usage counters

Workspace Object

{
  "id":              "ws_xxxx",
  "name":            "Acme Corp",
  "slug":            "acme-corp",
  "logoUrl":         null,
  "primaryColor":    "#6366f1",
  "defaultLanguage": "en",
  "timezone":        "Europe/Prague",
  "plan":            "pro",
  "createdAt":       "2024-11-14T10:00:00Z"
}

Invite a Member

POST /workspaces/:id/invitations

{
  "email": "bob@example.com",
  "role":  "editor"    // "admin" | "editor" | "viewer"
}

// 200 OK
{
  "invited": true,
  "email": "bob@example.com"
}

Create an API Key

POST /workspaces/:id/api-keys

{
  "name": "Production SDK key"
}

// 201 Created
{
  "id":   "key_xxxx",
  "name": "Production SDK key",
  "key":  "pk_live_xxxxxxxxxxxx"  // shown only once for public SDK keys
}

Usage Object

GET /workspaces/:id/usage

{
  "responsesUsed":     312,
  "responsesLimit":    1000,
  "aiGenerationsUsed":  18,
  "aiGenerationsLimit": 50,
  "periodStart":       "2024-11-01T00:00:00Z",
  "periodEnd":         "2024-11-30T23:59:59Z"
}