API Reference
Programmatic access to WorkClaw for managing agents, deployments, skills, and team settings. Overview of the REST API, authentication, and available endpoints.
What can I do with the WorkClaw API?
The WorkClaw API provides programmatic access to the same capabilities available through the web dashboard. Use the API to automate agent management, integrate WorkClaw into CI/CD pipelines, or build custom tooling on top of the platform.
Common use cases include:
- Trigger deployments from CI/CD after merging configuration changes.
- Manage skills programmatically -- install, uninstall, or update skills on your Claws.
- Monitor health by polling runtime status and error rates. See Monitoring.
- Manage team members -- invite, update roles, or remove members via API. See Team Management.
- Send messages to a Claw and receive responses for custom integrations beyond Slack or the web chat.
How is the API structured?
The WorkClaw API is a RESTful JSON API. All requests and responses use JSON. The base URL is:
https://api.workclaw.com/v1
Endpoints are organized by resource:
/v1/claws-- manage Claws and their configurations./v1/deployments-- trigger and monitor deployments./v1/skills-- manage skill installations./v1/team-- manage team membership and settings./v1/chat-- send messages and retrieve conversation history.
For the full list, see API Endpoints.
How do I authenticate?
All API requests require authentication via an API key passed in the Authorization header. See API Authentication for instructions on generating and managing API keys.
What are the rate limits?
API requests are rate-limited per team:
| Plan | Requests per minute |
|---|---|
| Starter | 60 |
| Professional | 300 |
| Enterprise | Custom |
Rate limit headers (X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset) are included in every response. See Billing for plan details.
Where should I start?
- Generate an API key.
- Review the Endpoints to find the resources you need.
- Make your first request -- try
GET /v1/clawsto list your agents.