API Overview

​

Base URL

http://127.0.0.1:3000

​

Response Conventions

• { "data": ... }
• { "data": ..., "meta": ... }

​

Common Status Codes

• 200 success
• 201 created
• 400 invalid input
• 403 forbidden (policy/gate)
• 404 not found
• 428 typed confirmation required (some routes)
• 500 server error
• 502/503 upstream OpenClaw/gateway unavailable patterns

​

Policy Errors (Typed Confirm / Approval)

• TYPED_CONFIRM_REQUIRED
• TYPED_CONFIRM_INVALID

{
  "error": "Typed confirmation required for \"Ship work order\"",
  "code": "TYPED_CONFIRM_REQUIRED",
  "details": {
    "actionKind": "work_order.ship",
    "confirmMode": "WO_CODE",
    "required": "WO-1234"
  }
}

{
  "error": "TYPED_CONFIRM_REQUIRED",
  "policy": {
    "riskLevel": "danger",
    "confirmMode": "CONFIRM",
    "requiresApproval": false
  }
}

​

cURL-first Example

curl -sS "http://127.0.0.1:3000/api/work-orders?limit=10"

​

Grouped API Pages

• Config and Init
• OpenClaw, Console, and Cron
• Work Orders, Operations, and Receipts
• Agents, Templates, and Stations
• Workflows, Teams, and Packages
• Plugins, Skills, and Models
• Workspace, Maintenance, Security, and Sync
• Streaming (SSE)
• Endpoint Index

​

Last updated

​

Related pages

• Local-only Networking Enforcement
• Architecture
• Troubleshooting