OpenClaw - API易文档中心

Overview

OpenClaw is an open-source local AI assistant created by developer Peter Steinberger in November 2025. It runs on your own computer and interacts through various chat platforms like Telegram, WhatsApp, Discord, etc., enabling file operations, terminal command execution, browser control, and other automation tasks. By configuring APIYI service, you can get:

🔒 Local Privacy

Data is processed locally, ensuring privacy and security

📱 Multi-Platform

Supports Telegram, WhatsApp, Discord, Slack, iMessage, and more

🛠️ Autonomous Execution

Not just chat - actually operates your computer and executes commands

🔌 Extensible

Supports custom skills and plugin extensions

Project Info: OpenClaw is an MIT-licensed open-source project. Website: openclaw.ai, Repository: github.com/openclaw/openclaw.

Prerequisites

System Requirements

Node.js 22 or higher
macOS / Linux / Windows

Install Node.js

macOS (Homebrew)
Other Systems

brew install node@22

Install OpenClaw

npm install -g openclaw

Verify installation:

openclaw --version

Quick Configuration

OpenClaw uses a JSON configuration file located at ~/.openclaw/openclaw.json.

Configure APIYI

Create or edit the configuration file ~/.openclaw/openclaw.json:

{
  "agents": {
    "defaults": {
      "model": { "primary": "apiyi/gpt-4.1" }
    }
  },
  "models": {
    "providers": {
      "apiyi": {
        "baseUrl": "https://api.apiyi.com/v1",
        "apiKey": "sk-your-apiyi-key",
        "api": "openai-completions",
        "models": [
          { "id": "gpt-4.1", "name": "GPT-4.1" },
          { "id": "claude-sonnet-4-20250514", "name": "Claude Sonnet 4" },
          { "id": "deepseek-chat", "name": "DeepSeek V3" },
          { "id": "gemini-2.5-pro-preview-05-06", "name": "Gemini 2.5 Pro" }
        ]
      }
    }
  }
}

Configuration Reference

Field	Description
`agents.defaults.model.primary`	Default model, format: `provider/model-name`
`models.providers`	Custom model provider configuration
`baseUrl`	API endpoint, use `https://api.apiyi.com/v1`
`apiKey`	Your APIYI key
`api`	API type: `openai-completions` for OpenAI compatible, `anthropic-messages` for Anthropic compatible

Run Setup Wizard

openclaw onboard

The wizard will guide you through:

Gateway configuration
Chat channel connection (Web UI, Telegram, WhatsApp, etc.)
Skills configuration

Start the Service

openclaw gateway start

Usage Methods

Method 1: Web UI (Recommended)

The simplest method, no external services required:

openclaw dashboard

Your browser will open http://127.0.0.1:18789/ where you can chat directly in the web interface.

Web UI is the recommended method as it works directly without any proxy requirements.

Method 2: Telegram Bot

Search for @BotFather on Telegram
Send /newbot to create a bot
Get the Bot Token
Enter the Token during openclaw onboard

If you’re in a region where Telegram requires a proxy:

export https_proxy=http://127.0.0.1:proxy-port
export http_proxy=http://127.0.0.1:proxy-port
openclaw gateway restart

Method 3: Other Platforms

OpenClaw also supports:

WhatsApp (scan QR to connect)
Discord (requires creating a Bot)
Slack, Signal, iMessage, Microsoft Teams, etc.

Core Skills

OpenClaw comes with rich built-in skills for various tasks:

File Operations

Skill	Function
`fs.read`	Read files (text/images)
`fs.write`	Write/create files
`fs.edit`	Edit file content

System Operations

Skill	Function
`shell.exec`	Execute terminal commands
`shell.process`	Manage running commands
`browser.*`	Browser automation (open pages, screenshot, click, etc.)

Smart Features

Skill	Function
`web_search`	Web search
`web_fetch`	Fetch web content
`memory_search`	Search memory
`memory_get`	Retrieve memory
`cron.*`	Scheduled tasks (reminders, automation)
`tts`	Text-to-speech

Common Commands

Terminal Commands

Command	Function
`openclaw onboard`	Run setup wizard
`openclaw gateway start`	Start Gateway service
`openclaw gateway restart`	Restart Gateway service
`openclaw gateway stop`	Stop Gateway service
`openclaw status`	Check running status
`openclaw doctor`	Diagnose configuration issues
`openclaw doctor --fix`	Auto-fix configuration issues
`openclaw dashboard`	Open Web control panel
`openclaw logs --follow`	View real-time logs
`openclaw configure`	Modify configuration
`openclaw update`	Update to latest version

Chat Commands

Commands available in the chat window:

Command	Function
`/help`	Show help
`/new`	Start new conversation
`/reset`	Reset conversation
`/stop`	Stop current task
`/think <level>`	Set thinking depth
`/model <id>`	Switch model
`/verbose on/off`	Toggle verbose mode
`/status`	Check status
`/skills`	View available skills

Usage Examples

Chat naturally with OpenClaw and it will understand and execute tasks:

File Operations

> Create a test.txt file on my desktop with content "hello world"

> Read the content of ~/Documents/notes.txt

> Move all .png files from desktop to Pictures folder

Terminal Commands

> List all files on my desktop

> Check current system memory usage

> Install the Python requests library

Browser Control

> Open browser and visit google.com

> Search for the latest MacBook Pro prices

> Take a screenshot of the current webpage

Scheduled Tasks

> Remind me to drink water every day at 9am

> Remind me to take a break every hour

> Remind me about the meeting tomorrow at 3pm

Programming Assistance

> Write a Python script to batch rename files

> What's wrong with this code: [paste code]

> Create a simple HTML page for me

Recommended Models

OpenClaw supports 200+ mainstream AI models through APIYI. Choose the right model for different tasks.

View Model Recommendations

Check the latest scenario-based model recommendations, including text creation, programming, quick response, long document processing, and more.

Scenario-Based Recommendations

Task Type	Recommended Model	Reason
Complex Task Execution	Claude Sonnet 4	Strong comprehension, accurate execution
Daily Conversation	GPT-4.1	Natural responses, good versatility
Code Writing	DeepSeek V3	Strong coding ability, cost-effective
Long Document Processing	Gemini 2.5 Pro	Supports ultra-long context

Troubleshooting

Can't connect to Telegram

Telegram may require a proxy in some regions. Set up terminal proxy and restart Gateway:

export https_proxy=http://127.0.0.1:proxy-port
export http_proxy=http://127.0.0.1:proxy-port
openclaw gateway restart

Or use Web UI directly (no proxy needed).

Configuration file format error

Run diagnostic command to auto-fix:

openclaw doctor --fix

API connection failed

Check if API key is correct
Confirm baseUrl is set to https://api.apiyi.com/v1
Test connectivity:

curl -H "Authorization: Bearer your-key" \
     https://api.apiyi.com/v1/models

How to view runtime logs

openclaw logs --follow

How to update OpenClaw

openclaw update

How to add new chat channels

openclaw channels add --channel telegram

Advanced Features

Multi-Model Configuration

Configure multiple models and switch between them using /model <id> in chat:

{
  "models": {
    "providers": {
      "apiyi": {
        "baseUrl": "https://api.apiyi.com/v1",
        "apiKey": "sk-your-key",
        "api": "openai-completions",
        "models": [
          { "id": "gpt-4.1", "name": "GPT-4.1" },
          { "id": "claude-sonnet-4-20250514", "name": "Claude Sonnet 4" },
          { "id": "deepseek-chat", "name": "DeepSeek V3" }
        ]
      }
    }
  }
}

Custom Skills

OpenClaw supports custom skills. Create them in the ~/.openclaw/workspace/skills/ directory.

Memory Feature

OpenClaw remembers your conversations and preferences. Use /memory to view and manage memory.

Multi-Device Sync

Run OpenClaw on multiple devices and use tools like Tailscale for remote access.

Security Tips

API Key Security: Never share your configuration file with others
Permission Control: OpenClaw can execute terminal commands - avoid dangerous operations
Network Security: By default, it only listens on localhost. Configure proper security measures for remote access

Complete Configuration Example

{
  "agents": {
    "defaults": {
      "model": { "primary": "apiyi/gpt-4.1" }
    }
  },
  "models": {
    "providers": {
      "apiyi": {
        "baseUrl": "https://api.apiyi.com/v1",
        "apiKey": "sk-your-apiyi-key",
        "api": "openai-completions",
        "models": [
          { "id": "gpt-4.1", "name": "GPT-4.1" },
          { "id": "claude-sonnet-4-20250514", "name": "Claude Sonnet 4" },
          { "id": "deepseek-chat", "name": "DeepSeek V3" }
        ]
      }
    }
  },
  "channels": {
    "telegram": {
      "enabled": true,
      "accounts": {
        "default": {
          "token": "your-telegram-bot-token"
        }
      }
    }
  }
}

APIYI Console

Manage API keys and view usage

Model Recommendations

View scenario-based model recommendations

Overview

Conversational AI

Programming

Engineering

Translation

​Overview

🔒 Local Privacy

📱 Multi-Platform

🛠️ Autonomous Execution

🔌 Extensible

​Prerequisites

​System Requirements

​Install Node.js

​Install OpenClaw

​Quick Configuration

​Configure APIYI

​Configuration Reference

​Run Setup Wizard

​Start the Service

​Usage Methods

​Method 1: Web UI (Recommended)

​Method 2: Telegram Bot

​Method 3: Other Platforms

​Core Skills

​File Operations

​System Operations

​Smart Features

​Common Commands

​Terminal Commands

​Chat Commands

​Usage Examples

​File Operations

​Terminal Commands

​Browser Control

​Scheduled Tasks

​Programming Assistance

​Recommended Models

View Model Recommendations

​Scenario-Based Recommendations

​Troubleshooting

​Advanced Features

​Multi-Model Configuration

​Custom Skills

​Memory Feature

​Multi-Device Sync

​Security Tips

​Complete Configuration Example

​Related Resources

APIYI Console

Model Recommendations

Overview

Prerequisites

System Requirements

Install Node.js

Install OpenClaw

Quick Configuration

Configure APIYI

Configuration Reference

Run Setup Wizard

Start the Service

Usage Methods

Method 1: Web UI (Recommended)

Method 2: Telegram Bot

Method 3: Other Platforms

Core Skills

File Operations

System Operations

Smart Features

Common Commands

Terminal Commands

Chat Commands

Usage Examples

File Operations

Terminal Commands

Browser Control

Scheduled Tasks

Programming Assistance

Recommended Models

Scenario-Based Recommendations

Troubleshooting

Advanced Features

Multi-Model Configuration

Custom Skills

Memory Feature

Multi-Device Sync

Security Tips

Complete Configuration Example

Related Resources