Sym Workspace API · stable
Build with your Sym workspace.
Manage Agents, conversations, files, apps and workspace resources through a scoped HTTP API. Account endpoints separately manage your own apps and Passes.
Choose your workspace
Sign in to Sym and open the workspace you can access. Copy its workspace ID; a workspace name is not an API identifier.
Create a scoped API key
Use the workspace API-key controls to create a key with agents:read. Keep it on your server, not in frontend JavaScript.
List available Agents
Set WORKSPACE_ID and SYM_WORKSPACE_API_KEY in your local environment, then run the example below.
Start here
Quickstart
Make your first read-only request to an existing workspace.
Connect securelyAuthentication
Use the credential type required by the operation.
API referenceList available Agents
List only Agents the key owner can currently access. Staff-only and unassigned Agents are not disclosed.
Get started
Quickstart
Make your first read-only request to an existing workspace.
Authentication
Use the credential type required by the operation.
Errors and pagination
Handle bounded results and uncertain outcomes without repeating side effects.
Account apps & Passes
List account Bridge apps
List account Bridge apps. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
Inspect app readiness
Inspect app readiness. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
List connected Chrome profiles
List connected Chrome profiles. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
Inspect recent app management receipts
Inspect recent app management receipts. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
Enable or disable app browser access
Enable or disable app browser access. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
List account-authorized browser Passes
List account-authorized browser Passes. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
List browser Passes on one app
List browser Passes on one app. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
Create an app browser Pass
Create an app browser Pass. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
Revoke a browser Pass on its app
Revoke a browser Pass on its app. Account API key only; a workspace key, workspace administrator role or attached browser Pass is not account authority.
Conversation browser Passes
List conversation browser Pass
Requires separate account delegation and workspace authority belonging to the same user, plus current target profile/chat access. Reuses the UI grant lifecycle; never executes browser actions.
Attach conversation browser Pass
Requires separate account delegation and workspace authority belonging to the same user, plus current target profile/chat access. Reuses the UI grant lifecycle; never executes browser actions.
Permission conversation browser Pass
Requires separate account delegation and workspace authority belonging to the same user, plus current target profile/chat access. Reuses the UI grant lifecycle; never executes browser actions.
Detach conversation browser Pass
Requires separate account delegation and workspace authority belonging to the same user, plus current target profile/chat access. Reuses the UI grant lifecycle; never executes browser actions.
Identity
Get the WorkspaceAPI root
Confirm the selected workspace API version and discover its documentation route.
Get the OpenAPI contract
Download the worker's generated OpenAPI 3.1 contract for this WorkspaceAPI version.
Get the current actor
Resolve the user and workspace represented by this API key. Permissions are evaluated from current workspace membership on every request.
Get the workspace
Return the workspace bound to the key, including capabilities currently available to its owning user.
Machine
Get machine information
Return safe identity and capability information for the SYM-node machine serving this workspace without exposing host credentials or private network configuration.
Get storage usage
Return total, used, and available workspace-machine storage with normalized byte counts and percentages.
Get memory usage
Return total, used, available, and cached RAM for the workspace machine.
API keys
List my API keys
List metadata for keys owned by the current WorkspaceAPI actor. Raw secrets are never returned after creation or rotation.
Create an API key
Create a user-bound key for this workspace. The raw secret is returned exactly once.
Rotate an API key
Revoke a user-owned key and return a replacement secret once without broadening its scopes.
Revoke an API key
Immediately revoke one of the current WorkspaceAPI actor's keys.
Agents
List available Agents
List only Agents the key owner can currently access. Staff-only and unassigned Agents are not disclosed.
Create an Agent
Start creation of a real SYM-node profile, Hermes profile, Gateway, runtime, and initial chat.
Get an Agent
Get one authorized Agent and its current runtime state.
Update an Agent
Rename or archive an Agent when the current user is allowed to manage it.
Delete an Agent
Delete an Agent through the same guarded lifecycle used by Workspace Settings.
List Agent apps
List apps installed for one accessible Agent, enriched with safe managed-process state.
Get Agent soul
Read the authorized Agent identity layer together with safe effective-instruction metadata.
Update Agent soul
Replace the authorized Agent identity markdown with optimistic revision checking. Workspace admin permission is required.
Get Agent autonomy settings
Read the persistent Hermes command-approval mode for one authorized Agent. This is the same per-profile setting shown under right-click Agent → Edit profile identity → Autonomy.
Update Agent autonomy settings
Set the persistent Hermes command-approval mode for one authorized Agent. Workspace owner/admin permission is required.
Get Agent brief
Return one authorized Agent's safe state, recent chats and unread-chat count in one bounded response.
Files & folders
List files and folders
Browse an Agent's project-files tree using paths relative to its guarded root.
Read a file
Read a supported project file as content and metadata.
Create or replace a file
Write a project file. Parent folders may be created explicitly before writing.
Download a file
Download the raw bytes of a project file.
Create a folder
Create a folder under the Agent's project-files root.
Move or rename a file or folder
Move one project entry without exposing host filesystem paths.
Delete a file or folder
Delete an entry. Non-empty folders require explicit recursive deletion.
Chats
List chats
List chats owned by one currently accessible Agent.
Create a chat
Create a durable Agent chat, optionally with an initial user message. This creates a chat record; it does not restart the Agent Gateway or guarantee a fresh profile runtime.
Get a chat
Get one accessible chat and its owning Agent.
Update a chat
Rename, archive, unarchive, or mark an accessible chat as read.
Delete a chat
Archive a chat when the current user has the same permission in Symposium. Archiving preserves history and does not reset or terminate its runtime.
Messages
List messages
Read normalized durable user, assistant, and system messages in chronological order.
Send a message
Queue a user-authored message through the same durable SYM-node and Gateway flow used by SYM-OS. Hermes slash commands are preserved exactly; send /new to request a reset of this exact chat's current Hermes conversation.
Get message status
Poll one durable message until it completes or fails.
Stream chat progress
Open a Server-Sent Events stream for durable message, activity, tool, and chat-state changes.
Get latest chat messages
Return the bounded latest message tail for one authorized Agent chat in chronological order.
Operations
List operations
List durable asynchronous operations owned by the current user.
Get an operation
Read durable status, result, or safe failure details.
Resume operation events
Resume an SSE stream with Last-Event-ID.
Cancel an operation
Request cancellation without deleting durable history.
Webhooks
List webhooks
List user-owned signed webhook subscriptions.
Create a webhook
Create an HTTPS-only subscription. The signing secret is revealed once.
Update a webhook
Change a user-owned webhook name, HTTPS destination, subscribed events, or active/paused status.
Revoke a webhook
Permanently revoke a user-owned webhook while preserving its durable delivery history.
Queue a webhook test
Queue a signed webhook.test delivery using a synthetic payload and the normal durable delivery system.
List webhook deliveries
Inspect retry and response status without exposing payload secrets.
Secrets
List Agent secret configuration
List configured environment-secret names and process-environment instructions for one accessible Agent. Secret values and broker-only storage paths are never returned. Workspace owner/admin permission is required.
Set or remove Agent secrets
Set write-only Agent environment secrets or remove configured names, then restart that Agent's gateway so the new environment takes effect. Workspace owner/admin permission is required.
List app secret configuration
List manifest-declared secret names and configured state for one installed Agent app. Secret values are never returned. Workspace owner/admin permission is required.
Set or remove app secrets
Set or remove manifest-declared write-only secrets for one installed Agent app, then restart the Agent gateway environment. Workspace owner/admin permission is required.
Workspace
Search accessible resources
Search accessible chats and messages without crossing Agent authorization boundaries.
Get recent workspace activity
Return a bounded snapshot of the most recent chats for every Agent the current key owner can access, optionally including the latest normalized messages.
Get compact workspace overview
Return small authorization-filtered counts for Agents, chats, and operations without listing resource payloads.
Get workspace settings
Read the safe workspace settings document stored by the worker.
Get workspace instructions
Read workspace instruction markdown and safe effective-layer metadata.
Update workspace instructions
Replace workspace instruction markdown with optimistic revision checking and rematerialize authorized Agent instructions. Workspace admin permission is required.
Get safe Cosmise connection status
Read safe profile-binding and synchronization-job status without exposing connection grants or provider credentials. Workspace admin permission is required.
List schedules
Read safe scheduled-job state.
OAuth
Other products: Sym Passes MCP →