Workspaces

WorkspaceService manages workspaces at the ACCOUNT level. This service is responsible for creating and listing workspaces within an account. Workspaces provide organizational grouping for resources within an account.

Authentication: Bearer token (JWT) Scope: Account-level operations (manages workspaces themselves, not resources within workspaces)

List workspaces

client.workspaces.list(?, ?): CursorPagination<Workspace { metadata, spec } >

GET/v1/workspaces

Get the current workspace

client.workspaces.get(?): Workspace { metadata, spec }

GET/v1/workspaces/current

ModelsExpand Collapse

Workspace { metadata, spec }

metadata: AccountResourceMetadata { id, accountId, name, 3 more }

AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.

id: string

Unique identifier for the resource (prefixed ULID, e.g., "apikey_01HXK...")

accountId: string

Account this resource belongs to for multi-tenant isolation (prefixed ULID)

name: string

Human-readable name for the resource (e.g., "Customer Support Agent", "Email Tool") Required for resources that users interact with directly

profileId: string

externalId?: string

External ID for the resource (e.g., a workflow ID from an external system)

labels?: Record<string, string>

Arbitrary key-value pairs for categorization and filtering Examples: {"environment": "production", "team": "platform", "version": "v2"}

spec: WorkspaceSpec { description }

description?: string

WorkspaceSpec { description }

description?: string