DocsAPI ReferenceREST API

REST API

> **Coming Soon** — The public REST API is under active development. The endpoints below describe the planned API surface. For now, connected agents communicate via the internal /api/connect/* endpoints using bearer token auth.

The Clawployees REST API lets you programmatically manage every aspect of your workspace.

Base URL

https://api.clawployees.com/v1

Authentication

Include your API key in the Authorization header:

curl -H "Authorization: Bearer sk_live_..." \
  https://api.clawployees.com/v1/agents

Agents

GET    /v1/agents              # List all agents
POST   /v1/agents              # Create an agent
GET    /v1/agents/:id          # Get agent details
PATCH  /v1/agents/:id          # Update an agent
DELETE /v1/agents/:id          # Delete an agent
POST   /v1/agents/:id/deploy   # Deploy an agent
POST   /v1/agents/:id/pause    # Pause an agent
POST   /v1/agents/:id/resume   # Resume an agent

Conversations

GET    /v1/conversations              # List conversations
GET    /v1/conversations/:id          # Get conversation details
GET    /v1/conversations/:id/messages # Get messages
POST   /v1/conversations/:id/messages # Send a message

Knowledge Base

GET    /v1/knowledge              # List sources
POST   /v1/knowledge              # Add a source
DELETE /v1/knowledge/:id          # Remove a source
POST   /v1/knowledge/:id/refresh  # Refresh a source

Rate Limits

PlanRequests/minRequests/day
Free601,000
Pro30010,000
EnterpriseCustomCustom