ReClaw API docs for agents, backup automation, and MCP.

Use the OpenAPI document, API-key auth model, structured JSON errors, SSE progress stream, CLI installer, and discovery files to automate OpenClaw backup and recovery workflows.

API Docs OpenAPI JSON Auth Markdown MCP Endpoint

Quickstart

Agents should prefer the CLI for operational backup work and the API for integrations. The API contract is published at /openapi.json.

curl -fsSL https://reclaw.io/install.sh | sh
reclaw backup bootstrap
reclaw backup create --label "Before deploy"

Authentication

Use scoped API keys. The API accepts either Authorization: Bearer <key> or x-api-key: <key>.

backups:read reads backup account and backup records.
backups:write creates uploads, finalizes backups, and manages vault wrapping material.
backups:restore downloads encrypted archive content.

Endpoints

Method	Path	Purpose
GET	`/api/backup-account`	Read encrypted backup account state.
PATCH	`/api/backup-account`	Reserved cadence update endpoint.
POST	`/api/backup-account/bootstrap`	Initialize client-wrapped vault material.
POST	`/api/backup-account/rotate`	Rotate wrapped vault material.
POST	`/api/backup-account/reset`	Reset backup account state.
GET	`/api/backups`	List visible backups.
POST	`/api/backups`	Create encrypted archive upload slot.
POST	`/api/backups/upload`	Upload encrypted archive bytes.
GET	`/api/backups/{id}`	Read backup detail.
DELETE	`/api/backups/{id}`	Delete a backup.
POST	`/api/backups/{id}/finalize`	Finalize encrypted backup metadata.
GET	`/api/backups/{id}/content`	Download encrypted archive bytes.
GET	`/api/backups/{id}/events`	Stream backup status progress events over Server-Sent Events.

Streaming Progress

Agents can subscribe to backup status progress with GET /api/backups/<backup-id>/events. The route returns text/event-stream and emits backup.status frames until the backup reaches a terminal state or the stream times out.

curl -N \
  -H "Accept: text/event-stream" \
  -H "Authorization: Bearer $RECLAW_TOKEN" \
  https://reclaw.io/api/backups/<backup-id>/events

JSON Errors

API failures use structured JSON so agents can parse a stable code, display a message, and follow a resolution hint.

{
  "error": "Authentication is required.",
  "code": "authentication_required",
  "message": "Authentication is required.",
  "resolution": "Send a browser session or ReClaw API key with Authorization: Bearer <key> or x-api-key."
}

MCP

/mcp is a public read-only Streamable HTTP MCP endpoint for discovering ReClaw docs, pricing, CLI install commands, and developer guidance. Backup operations still use the authenticated API or CLI.

Webhooks

ReClaw does not currently emit outbound webhooks. Use the SSE progress stream for in-flight status and the documented backup endpoints for durable state. See webhook docs.

Agent Discovery

ReClaw publishes these machine-readable discovery resources: