Workspaces

Read workspace identity, manage settings and members, issue invitations, and control API keys with explicit administrative scopes.

GET/api/workspaces
200 OK

List workspaces visible to the current user or API key.

Required scopeworkspace:read
GET/api/workspaces/current
200 OK

Read the workspace selected by the API key or X-Workspace-Id header.

Required scopeworkspace:read
GET/api/workspaces/current/api-entitlement
200 OK

Read the current plan, billing state, active key count, and effective API limits. This endpoint is available to an authenticated dashboard session even when API access is paused.

Required scopeworkspace:read
Response
{
  "enabled": true,
  "reason": null,
  "plan": "pro",
  "billingStatus": "active",
  "activeApiKeys": 2,
  "limits": {
    "readRequestsPerMinute": 1200,
    "writeRequestsPerMinute": 300,
    "requestsPerMonth": 2000000,
    "activeApiKeys": 10,
    "maxUploadBytes": 524288000
  }
}
PATCH/api/workspaces/current
200 OK

Update the workspace name or settings object.

Required scopeworkspace:admin
Request body
{
  "name": "SteadyLink Studio",
  "settings": { "theme": "steadylink" }
}
GET/api/workspaces/current/members
200 OK

List workspace members and roles.

Required scopeworkspace:read
POST/api/workspaces/current/invitations
201 Created

Invite a member with an expiration from 1 to 30 days.

Required scopeworkspace:admin
GET/api/workspaces/current/api-keys
200 OK

List key metadata. Raw key values are never returned here.

Required scopeworkspace:admin