curl or any HTTP client.
Base URL
cllk_live_ API key.
You only need this API if you are building your own integration or script. If you use
OpenClaw, Hermes, the CLI (
@useclawlink/cli), or any MCP client, use those surfaces
instead — they wrap this API and handle pairing, discovery, and retries for you. See
Quick Start.The mental model
ClawLink models everything as integrations → actions → executions:Integration
A connected app, identified by an
integration_id (its slug), e.g. gmail,
slack, instagram. You connect apps once in the dashboard.Action
Something an integration can do, identified by an
action_id, e.g. send_email,
send_message, post_ig_user_media.Execution
One run of an action with a specific
input. You POST an execution and get back a
normalized result.Your first request
Verify your API key and see who it belongs to:200 with this body means your key is valid. A 401 {"error":"Unauthorized"} means the
key is missing or wrong — see Authentication.
Run an action
Send a Gmail message in one call. Write actions requireconfirm: true:
confirm field, and runnable examples for Slack and
Instagram are in Executing actions.
What’s in this section
Authentication
API keys, the two accepted auth headers, and how to verify a key.
Executing actions
POST /api/executions, the confirm field, discovering action IDs and input
schemas, plus curl for Gmail, Slack, and Instagram.File uploads
Attaching images and documents — public URLs, the file-uploadable shape, and the
base64 envelope for local bytes.
Multi-step flows
Start, poll, approve, resume, and cancel server-run multi-step automations.
Errors
The error envelopes, HTTP status codes, the full error-code list, and how to recover.
Discovery
List integrations and actions, and fetch an action’s exact input schema.
Conventions
- Transport — JSON request and response bodies over HTTPS. Send
Content-Type: application/jsonon everyPOST. - Auth — every endpoint requires a
cllk_live_key (see Authentication). Unauthenticated requests get401. - Scope — a key acts as one ClawLink user. Executions run against that user’s connections.
- Rate limits — providers (Gmail, Slack, etc.) enforce their own rate limits;
ClawLink surfaces them as
rate_limited/ HTTP429. HonorRetry-Afterwhere present.
