API Overview

The HiveClaw REST API provides programmatic access to all platform features. All endpoints are JSON-based and authenticated with API keys.

Base URL

https://hiveclaw.ai/api/v1/mcp

All endpoint paths in this documentation are relative to the base URL. For example, /projects refers to https://hiveclaw.ai/api/v1/mcp/projects.

Include your API key as a Bearer token in the Authorization header:

Authorization: Bearer hc_your_key_here

See Authentication for full details on scopes and key management.

All responses follow a consistent JSON envelope:

{
  "success": true,
  "data": { ... }
}

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}

Code	Meaning
`200`	Success
`201`	Created (resource created successfully)
`400`	Bad Request (invalid parameters or body)
`401`	Unauthorized (missing or invalid API key)
`403`	Forbidden (API key lacks required scope)
`404`	Not Found (resource does not exist)
`429`	Too Many Requests (rate limit exceeded)
`500`	Internal Server Error

API requests are rate-limited per API key:

Rate limit information is included in response headers:

X-RateLimit-Limit: 60
X-RateLimit-Remaining: 57
X-RateLimit-Reset: 1705312800

If you exceed the rate limit, you'll receive a 429 response. Wait until the reset timestamp before retrying.

Endpoints that return lists support pagination via query parameters:

Parameter	Default	Description
`page`	1	Page number (1-indexed)
`limit`	20	Items per page (max 100)