Developers
Your systems can start automations, read their results and send events into work.studio. Pick the way in that fits what you’re building.
| Way in | Use it to | Credential |
|---|---|---|
| REST API | Run automations and read runs from any language | API key in X-API-Key |
| Incoming webhooks | Let another service start an automation when something happens | Webhook signing secret, optionally an API key |
| MCP | Let Claude Code, VS Code or another MCP client work with your organization | Your work.studio sign-in |
TypeScript SDK (@workstudio-inc/sdk) |
Embed the catalog in your product, or build an app your own users sign in to | Embed key and session tokens, or your app’s sign-in |
Python SDK (workstudio) |
Call work.studio from Python | API key |
App Kit (npx workstudio deploy) |
Host your App’s front-end at https://<address>.workstudio.run |
Organization API key |
The base URL
Section titled “The base URL”Every API path starts with https://api.work.studio/api/v1/workflow/.
- TypeScript and JavaScript:
npm i @workstudio-inc/sdk(0.11.x). The main entry point is the headless embed client.@workstudio-inc/sdk/appis the App SDK for apps whose own users sign in. The package has no client for running automations with an API key; use the REST API for that. - Python:
pip install workstudio(0.1.x). It reads your key fromWORKSTUDIO_API_KEY.workflows.list()andworkflows.get()need an organization key (svx_tk_): a customer key can’t read automation definitions and gets 403. With only Run Automation, they return a summary of each automation (its id, name and inputs); the full definition needs View Automation.
Start here
Section titled “Start here”API keysOrganization and customer keys, where to make them, and what their permissions do.
Run an automation from your codeStart a run with one POST, wait for it or poll, and fetch the result.
Incoming webhooksThe webhook URL, authentication, signatures and limits.
MCPConnect Claude Code or VS Code to your organization.
Ship an AppBuild the front-end in your own AI tool and host it on workstudio.run.
App SDKBuild an app your own users sign in to, on your agents and data.
Troubleshoot App sign-in and dataWhat each error from an App's sign-in or data call means.
App usageCount how your App is used, and time in app, anonymously.
API referenceThe base URL, authentication and errors.