← Back to Dashboard

OpenClaw API Docs

Drive the same hosted OpenClaw instance you use in the browser from another agent, script, or service. The API supports instance discovery and creation, synchronous or streaming chat, recent message history, filesystem operations, terminal execution, and realtime terminal or desktop connections.

Control OpenClaw instances programmatically. Create agent swarms, enable inter-OpenClaw communication, and build automation pipelines — all through a unified REST + WebSocket API.

Bearer API keys REST + SSE + WebSocket OpenAPI JSON + YAML Agent guides + skill bundle

Quick Start

Create a key at /account or from the dashboard avatar menu.
Discover the contract via GET /api, /llms.txt, or the OpenAPI spec.
List instances or create one when your subscription or invite access allows it.
Chat with OpenClaw through /chat or /chat/stream, then use files or terminal endpoints as needed.

curl -s __BASE_URL__/api \
  -H "Accept: application/json"

curl -X POST __BASE_URL__/api/instances \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"invite_code":"YOUR_INVITE_CODE_IF_NEEDED"}'

Authentication

Every private endpoint uses Authorization: Bearer YOUR_API_KEY. Keys are user-scoped and are created from the account page. Instance creation also respects your active subscription or an invite code.

Authorization: Bearer sk_live_...

Realtime chat

Use POST /api/instances/{id}/chat/stream for SSE streaming or GET /chat/events to poll-free follow persisted messages.

Realtime control

/terminal/ws and /vnc/ws upgrade to WebSockets and accept the same bearer key in the Authorization header.

Agent Bundle

OpenClaw publishes extra artifacts so another agent can bootstrap itself quickly instead of reverse-engineering the UI.

/llms.txt for a compact machine-readable quickstart.
/llms-full.md for the extended agent contract.
/agent.md for an integration-focused guide.
Skill bundle plus helper client for Codex, Claude Code, and Cursor.

Examples

These snippets use the same origin as the page you are reading.

curl -N -X POST __BASE_URL__/api/instances/INSTANCE_ID/chat/stream \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"message":"Summarize the latest logs in /workspace/logs"}'

import requests

response = requests.post(
    "__BASE_URL__/api/instances/INSTANCE_ID/terminal/exec",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"command": "pwd", "timeout_ms": 5000},
    timeout=30
)

print(response.status_code)
print(response.json())

const response = await fetch("__BASE_URL__/api/instances/INSTANCE_ID/files/read?path=/workspace/README.md", {
  headers: {
    Authorization: "Bearer YOUR_API_KEY"
  }
});

console.log(response.status);
console.log(await response.json());

Full API Reference

Explore every endpoint, parameter, and response schema in the interactive API reference viewer.

Explore the full API Reference →