API & Developer Guide

Extend ClawBox with custom skills, REST API integrations, and webhooks. Build powerful automations and connect to external services.

Quick Start

Terminal
# Connect to your ClawBox via SSH
# Default credentials: user "clawbox", password "clawbox"
ssh clawbox@clawbox.local

# Check API status
curl http://clawbox.local:8080/api/status

# Send a message
curl -X POST http://clawbox.local:8080/api/chat \
  -H "Content-Type: application/json" \
  -d '{"message": "Hello, ClawBox!"}'

REST API

ClawBox exposes a local REST API for programmatic control.

GET/api/status

Check the current status of your ClawBox.

Example:

curl http://clawbox.local:8080/api/status
POST/api/chat

Send a message and receive an AI response.

Example:

curl -X POST -H "Content-Type: application/json" -d {"message": "Hello"} http://clawbox.local:8080/api/chat
GET/api/skills

List all installed skills and their status.

Example:

curl http://clawbox.local:8080/api/skills
PUT/api/config

Update ClawBox configuration settings.

Example:

curl -X PUT -H "Content-Type: application/json" -d {"voice": true} http://clawbox.local:8080/api/config

Building Custom Skills

Skills are Python modules that extend ClawBox functionality. They can respond to triggers, call APIs, and integrate with external services.

Skill Structure

my-skill/
├── manifest.json      # Skill metadata
├── handler.py         # Main skill logic
├── requirements.txt   # Python dependencies
└── README.md          # Documentation

manifest.json

{
  "name": "weather-skill",
  "version": "1.0.0",
  "description": "Get weather information",
  "triggers": ["weather", "forecast", "temperature"],
  "author": "Your Name",
  "permissions": ["network"]
}

handler.py

from openclaw import Skill, Response

class WeatherSkill(Skill):
    def handle(self, message: str, context: dict) -> Response:
        # Parse location from message
        location = self.extract_location(message)

        # Fetch weather data
        weather = self.get_weather(location)

        return Response(
            text=f"Weather in {location}: {weather['temp']}°C",
            data=weather
        )

Installing Skills

Terminal
# Install a skill from GitHub
openclaw skill install github.com/user/weather-skill

# Install from local directory
openclaw skill install ./my-skill

# List installed skills
openclaw skill list

# Remove a skill
openclaw skill remove weather-skill

Webhooks

Receive real-time notifications when events occur on your ClawBox.

Available Events

🔔message.received
🔔message.sent
🔔skill.triggered
🔔system.status

Authentication

API requests require authentication using bearer tokens. Generate tokens using the CLI.

# Generate API token
openclaw token generate --name "my-app"

# Use token in requests
curl -H "Authorization: Bearer YOUR_TOKEN" \
  http://clawbox.local:8080/api/chat

Developer Resources

📚

GitHub Repository

Source code and examples

📚

Skill Marketplace

Community-built skills

📚

API Reference

Complete API documentation

📚

Discord Developers

Developer community chat