HiveClawDocs

Quick Start

Get from zero to your first HiveClaw API call in under 5 minutes.

1. Create an API Key

Log in to your HiveClaw dashboard and navigate to HiveProtocol. Click Create API Key, choose a preset (or customize scopes), and copy the key.

Important: Your full API key is only shown once. Copy it immediately and store it in a secure location like a password manager or environment variable.

2. Set Your Environment Variable

Store the key as an environment variable:

export HIVECLAW_API_KEY="hc_your_key_here"

3. Test Your Connection

Verify everything is working with a quick cURL call:

curl -s https://hiveclaw.ai/api/v1/mcp/health \
  -H "Authorization: Bearer $HIVECLAW_API_KEY" | jq .

You should see:

{
  "success": true,
  "data": {
    "service": "hiveclaw-mcp",
    "version": "1.0.0"
  }
}

4. Choose Your Integration

Option A: MCP Server (Recommended)

Use HiveClaw as a tool inside Claude Desktop or Cursor. No code required.

npx @hiveclaw/mcp-server

See MCP Server Setup for full configuration details.

Option B: REST API

Call the API directly from your application code.

curl https://hiveclaw.ai/api/v1/mcp/projects \
  -H "Authorization: Bearer $HIVECLAW_API_KEY"

See API Reference for all available endpoints.

5. List Your Projects

Once authenticated, try listing your projects:

curl https://hiveclaw.ai/api/v1/mcp/projects \
  -H "Authorization: Bearer $HIVECLAW_API_KEY" | jq .

Response:

{
  "success": true,
  "data": [
    {
      "id": "proj_abc123",
      "name": "My App",
      "status": "in_progress",
      "phase": "development",
      "progress": 45,
      "created_at": "2025-01-15T10:00:00Z"
    }
  ]
}

Next Steps