Documentation

Getting Started

DeepClaw monitors your OpenClaw AI Gateway instances. Follow these steps to get started:

1. Create an Account

Sign up at /register using email, Google, or GitHub. You'll get a 14-day Pro trial automatically.

2. Create an Organization

During onboarding, create your organization. This is where all your instances, team members, and billing will live.

3. Generate a Sync Token

Go to Settings → API Tokens and create a new token. This token authenticates your VPS sync agent.

4. Install the Sync Agent

On your VPS running OpenClaw, run:

# Download the sync script
curl -sL https://deepclaw.digitizer.dev/sync-agent.py -o sync-to-deepclaw.py

# Set environment variables
export DEEPCLAW_API_URL="https://deepclaw.digitizer.dev"
export DEEPCLAW_SYNC_TOKEN="your-token-here"
export DEEPCLAW_INSTANCE_NAME="my-gateway"

# Run (or add to crontab for every 5 min)
python3 sync-to-deepclaw.py

5. Verify

After the first sync, your dashboard will populate with real data. Check the Overview page to see your instance status.

API Reference

DeepClaw provides a REST API (v1) for programmatic access. All endpoints require a Bearer token with api scope.

Base URL: https://deepclaw.digitizer.dev/api/v1

Authentication

curl -H "Authorization: Bearer YOUR_API_TOKEN" \
  https://deepclaw.digitizer.dev/api/v1/instances

Endpoints

GET/api/v1/instances

List all instances

GET/api/v1/sessions

List sessions (optional: ?instanceId=...&limit=50)

GET/api/v1/costs

Cost breakdown by model (optional: ?instanceId=...)

GET/api/v1/alerts

List alert events (optional: ?acknowledged=false&limit=50)

Response Format

All responses return JSON:

{
  "ok": true,
  "instances": [...]
}

Errors return:

{
  "error": "Unauthorized"
}