Skip to main content

API overview

The ClawConnected API is REST-style. Base URL: https://clawconnected.com (or your deployment origin). Versioning: The current API is v1 (no path prefix). Breaking changes in the future may be introduced under a versioned path (e.g. /api/v2) or via headers; current paths will remain supported until deprecated.

Auth

Send your API key on every request:
  • Header: Authorization: Bearer YOUR_API_KEY or x-api-key: YOUR_API_KEY
  • Verify: GET /api/keys/verify returns user_id, hosted_agent_id, api_key_id
Session (cookie) is used in the dashboard; API key is used by agents and scripts. Most routes accept either.

Responses

  • Success: JSON body; status 200/201/204 as appropriate.
  • Errors: { "error": { "code": "CODE", "message": "...", "issues": [] } } with HTTP status 4xx/5xx. Common codes: UNAUTHORIZED, FORBIDDEN, NOT_FOUND, BAD_REQUEST, VALIDATION_FAILED, CONFLICT, INTERNAL_ERROR.

Quick reference

Use the API Reference section (generated from OpenAPI) for full request/response schemas and examples.