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:
Authorization: Bearer wk_your_key_here
Enabling workspace API access
Go to Workspace Settings → API Keys
Create a new key (or edit an existing one)
Check the Workspace read API scope
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.
Endpoint Description /workspaceapi/overviewWorkspace settings, feature flags, and configuration /workspaceapi/creditsCredit balance and per-agent/per-team usage /workspaceapi/membersAll workspace members with roles and team memberships /workspaceapi/invitesPending and expired workspace invitations /workspaceapi/teamsAll teams (add ?includeMembers=true for member lists) /workspaceapi/teams/:teamIdSingle team details with full member list /workspaceapi/secretsSecret names and metadata (values are never exposed) /workspaceapi/http-apisShared HTTP API capability configurations /workspaceapi/capability-settingsWhich capabilities are available and their defaults /workspaceapi/security-settingsSecurity alert configuration /workspaceapi/agentsAll agents (add ?includeOverview=true for management overview) /workspaceapi/value-captureValue capture compliance summary across agents
Per-agent endpoints Drill into a specific agent’s data. The agent must belong to the workspace and not be private (restricted access).
Endpoint Description /workspaceapi/agents/:agentIdFull agent configuration /workspaceapi/agents/:agentId/chatsChat conversation list /workspaceapi/agents/:agentId/chats/:chatIdSingle chat with full message history /workspaceapi/agents/:agentId/documentsAgent documents and folders /workspaceapi/agents/:agentId/documents/:docIdSingle document with content /workspaceapi/agents/:agentId/diaryDiary entries (filters: ?date=, ?conversationId=, ?year=&month=) /workspaceapi/agents/:agentId/activity-logActivity log (filters: ?limit=, ?page=, ?pageSize=, ?entryId=, ?newerThan=) /workspaceapi/agents/:agentId/messagesEmail/SMS messages (filters: ?page=, ?pageSize=, ?direction=, ?channel=, ?since=, ?until=) /workspaceapi/agents/:agentId/evalsEval definitions (add ?includeRecentResults=true for results) /workspaceapi/agents/:agentId/connected-agentsAgent-to-agent connections /workspaceapi/agents/:agentId/mcp-serversConnected MCP servers /workspaceapi/agents/:agentId/tool-usage/:toolNameUsage stats for a specific tool (filters: ?since=, ?limit=)
Example curl -s https://api.abundly.ai/workspaceapi/agents \ -H "Authorization: Bearer wk_your_key_here" | jq
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:
Scope What it grants Custom agent endpoints Access to agent-exposed APIs (HTTP API, Document API, MCP, Widget) on agents with “Allow Workspace Keys” enabled Workspace read API Read-only access to workspace and agent data via the /workspaceapi/ endpoints
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
