Skip to main content
The Workspace API gives external systems read-only access to workspace-level and per-agent data — the same information visible in the Workspace Explorer capability, but accessible over HTTP.

​
Authentication

Requests are authenticated with workspace API keys (wk_...) that have the Workspace read API scope enabled. Include the key as a Bearer token:

​
Enabling workspace API access

  1. Go to Workspace Settings → API Keys
  2. Create a new key (or edit an existing one)
  3. Check the Workspace read API scope
  4. Save and copy the key
Workspace API keys grant read access to all workspace data including chat histories, messages, member information, and agent configurations. Keep them secure and rotate them regularly.

​
Workspace endpoints

All endpoints are GET requests under /workspaceapi/. No workspace ID is needed in the URL — the key identifies the workspace.

​
Per-agent endpoints

Drill into a specific agent’s data. The agent must belong to the workspace and not be private (restricted access).

​
Example

​
Data redaction

Credential values, API keys, and secret values are automatically stripped from all responses — the same redaction rules applied by the Workspace Explorer capability. Secret names and metadata are included so you can see what’s configured without exposing sensitive values.

​
API key scopes

Workspace API keys support two scopes that can be enabled independently: Existing keys default to Custom agent endpoints only. Enable Workspace read API explicitly to use the endpoints documented on this page.

​
Learn more

API Access

Expose agents as HTTP APIs, MCP servers, webhooks, or chat widgets

Access Control

Workspace roles, team permissions, and agent access levels