|
| 1 | +# OpenClaw |
| 2 | + |
| 3 | +## About |
| 4 | + |
| 5 | +[OpenClaw](https://github.com/openclaw/openclaw) is a personal AI assistant that runs on your own devices. It connects to messaging channels (WhatsApp, Telegram, Slack, Discord, Google Chat, Signal, iMessage, Microsoft Teams, Matrix, Zalo, and more) and provides AI assistance with complete data privacy. |
| 6 | + |
| 7 | +Developers use OpenClaw to build multi-channel AI assistants with streaming responses, browser automation, vision capabilities, and voice integration. OpenClaw provides a Gateway service that runs locally on localhost:18789 by default, a CLI for management, and support for 12+ messaging platforms. |
| 8 | + |
| 9 | +All agent data is stored locally in your SQLite database located at `~/.openclaw/openclaw.db`. The Gateway runs on `localhost:18789` by default, keeping your AI assistant completely under your control. |
| 10 | + |
| 11 | +{% hint style="success" %} |
| 12 | +**Data Privacy**: All data is stored locally in your SQLite database! \ |
| 13 | +No data is sent externally unless you explicitly configure external integrations. |
| 14 | +{% endhint %} |
| 15 | + |
| 16 | +## Installation |
| 17 | + |
| 18 | +Get started with OpenClaw in seconds: |
| 19 | + |
| 20 | +```sh |
| 21 | +npm install -g openclaw@latest |
| 22 | +openclaw onboard --install-daemon |
| 23 | +``` |
| 24 | + |
| 25 | +The wizard installs the Gateway as a system service (`launchd` on macOS, `systemd` on Linux), so it stays running in the background. |
| 26 | + |
| 27 | +## How to Use AIML API with OpenClaw |
| 28 | + |
| 29 | +Configure OpenClaw to use AIML API as the default model provider. You have two options: environment variable or configuration file. |
| 30 | + |
| 31 | +### Configuration File |
| 32 | + |
| 33 | +Add to `~/.openclaw/openclaw.json`: |
| 34 | + |
| 35 | +{% code overflow="wrap" %} |
| 36 | +```python |
| 37 | +{ |
| 38 | + "providers": { |
| 39 | + "openai": { |
| 40 | + "apiKey": "<YOUR_AIMLAPI_KEY>", |
| 41 | + "baseUrl": "https://api.aimlapi.com/v1" |
| 42 | + } |
| 43 | + } |
| 44 | +} |
| 45 | +``` |
| 46 | +{% endcode %} |
| 47 | + |
| 48 | +### Start the Gateway |
| 49 | + |
| 50 | +``` |
| 51 | +openclaw gateway --port 18789 --verbose |
| 52 | +``` |
| 53 | + |
| 54 | +### **Use with OpenClaw Agent** |
| 55 | + |
| 56 | +``` |
| 57 | +openclaw agent \ |
| 58 | + --message "Tell me about yourself" \ |
| 59 | + --model gpt-4o |
| 60 | +``` |
| 61 | + |
| 62 | +<details> |
| 63 | + |
| 64 | +<summary>Response:</summary> |
| 65 | + |
| 66 | +{% code overflow="wrap" %} |
| 67 | +``` |
| 68 | +I'm an AI language model created by OpenAI, designed to assist with a wide range of inquiries by generating human-like text based on the input I receive. I can help with answering questions, providing explanations, and even engaging in creative writing. My knowledge is based on a diverse dataset that covers a wide variety of topics up until October 2023. However, I don't have personal experiences, emotions, or consciousness. My primary goal is to be as helpful and informative as possible! If you have any specific questions or need assistance, feel free to ask. |
| 69 | +``` |
| 70 | +{% endcode %} |
| 71 | + |
| 72 | +</details> |
| 73 | + |
| 74 | +## **Our Supported models** |
| 75 | + |
| 76 | +* All OpenAI-compatible models ([gpt-4o](../api-references/text-models-llm/OpenAI/gpt-4o.md), [gpt-4o-mini](../api-references/text-models-llm/OpenAI/gpt-4o-mini.md), [gpt-4-turbo](../api-references/text-models-llm/OpenAI/gpt-4-turbo.md), [gpt-3.5-turbo](../api-references/text-models-llm/OpenAI/gpt-3.5-turbo.md), [o3-mini](../api-references/text-models-llm/OpenAI/o3-mini.md), [o1](../api-references/text-models-llm/OpenAI/o1.md), etc), |
| 77 | +* [Google models](../api-references/text-models-llm/Google/), |
| 78 | +* [Anthropic models](../api-references/text-models-llm/Anthropic/) is only partially supported and only via `api.aimlapi.com/v2` base URL, |
| 79 | +* and some other models (the list is constantly being updated). |
| 80 | + |
| 81 | +## **Supported features** |
| 82 | + |
| 83 | +OpenClaw provides comprehensive capabilities for building production-ready multi-channel assistants: |
| 84 | + |
| 85 | +* **Multi-channel routing** — Connect to 12+ messaging platforms including WhatsApp, Telegram, Slack, Discord, and more |
| 86 | +* **Real-time streaming responses** — Responses stream back to users as they're generated for improved user experience |
| 87 | +* **Vision and image processing** — Analyze images from web pages or user uploads using vision-capable models |
| 88 | +* **Browser automation and control** — OpenClaw-managed Chrome instance for automated web interactions and page analysis |
| 89 | +* **Voice capabilities** — Voice wake detection and talk mode for hands-free interaction on macOS, iOS, and Android |
| 90 | +* **Session management and conversation history** — Maintain context and conversation history across user interactions |
| 91 | +* **Function calling and tool integration** — Integrate custom tools, skills, and external services into your agents |
| 92 | +* **Error handling and auto-retry** — Robust error management with exponential backoff retry mechanisms |
| 93 | + |
| 94 | +## Code Examples |
| 95 | + |
| 96 | +<details> |
| 97 | + |
| 98 | +<summary><strong>Prerequisites</strong></summary> |
| 99 | + |
| 100 | +1\. Install OpenClaw |
| 101 | + |
| 102 | +```bash |
| 103 | +npm install -g openclaw@latest |
| 104 | +openclaw onboard --install-daemon |
| 105 | +``` |
| 106 | + |
| 107 | +2\. Export your [AIMLAPI\_KEY](https://aimlapi.com/app/keys) |
| 108 | + |
| 109 | +```bash |
| 110 | +export AIMLAPI_API_KEY=*** |
| 111 | +``` |
| 112 | + |
| 113 | +3\. Start the Gateway |
| 114 | + |
| 115 | +```bash |
| 116 | +openclaw gateway --port 18789 |
| 117 | +``` |
| 118 | + |
| 119 | +</details> |
| 120 | + |
| 121 | +For configuring functions, simply follow the built-in OpenClaw instructions. |
| 122 | + |
| 123 | +<div align="left"><figure><img src="../.gitbook/assets/1.2.png" alt=""><figcaption></figcaption></figure></div> |
| 124 | + |
| 125 | +<div align="left"><figure><img src="../.gitbook/assets/1.3.png" alt=""><figcaption></figcaption></figure></div> |
| 126 | + |
| 127 | +### Stream mode |
| 128 | + |
| 129 | +Configure streaming responses for real-time chat using Telegram. |
| 130 | + |
| 131 | +**What happens**: |
| 132 | + |
| 133 | +1. User sends message to Telegram bot. |
| 134 | +2. Gateway receives message and routes to OpenClaw Agent. |
| 135 | +3. OpenClaw calls AIML API with gpt-4o-mini model. |
| 136 | +4. Response streams word-by-word from AIML API. |
| 137 | +5. User sees real-time streaming chat experience in Telegram. |
| 138 | + |
| 139 | +**Result**: Users see responses appear word-by-word as they're generated in real-time, providing better user experience. |
| 140 | + |
| 141 | +### Multi-Channel Setup (Slack + Discord) |
| 142 | + |
| 143 | +Route messages from multiple platforms to the same agent. |
| 144 | + |
| 145 | +**What happens**: |
| 146 | + |
| 147 | +1. User messages OpenClaw bot on Slack or Discord. |
| 148 | +2. Gateway receives message and identifies platform source. |
| 149 | +3. OpenClaw routes message to Agent with platform context. |
| 150 | +4. Agent calls AIML API with gpt-4o model. |
| 151 | +5. Response returns to same channel where message originated. |
| 152 | + |
| 153 | +**Result**: Single agent serves both Slack and Discord users simultaneously, maintaining consistent behavior across platforms. |
| 154 | + |
| 155 | +### Vision with Browser |
| 156 | + |
| 157 | +Analyze web pages using vision models. |
| 158 | + |
| 159 | +**What happens**: |
| 160 | + |
| 161 | +1. User requests web page analysis through messaging channel. |
| 162 | +2. OpenClaw opens Chrome browser instance (CDP controlled). |
| 163 | +3. Takes screenshot of specified page. |
| 164 | +4. Sends screenshot to AIML API vision model (gpt-4o). |
| 165 | +5. Model analyzes and returns detailed description. |
| 166 | +6. Results sent back to user through messaging channel. |
| 167 | + |
| 168 | +**Result**: Agent provides detailed description of web page content, layout, and visual elements. |
| 169 | + |
| 170 | +*** |
| 171 | + |
| 172 | +## More |
| 173 | + |
| 174 | +For further information about OpenClaw and AIML API integration, check out: |
| 175 | + |
| 176 | +* [Official OpenClaw Documentation](https://docs.openclaw.ai) |
| 177 | +* [GitHub Repository - OpenClaw](https://github.com/openclaw/openclaw) |
| 178 | +* [Examples & Cookbook](https://github.com/openclaw/openclaw/tree/main/cookbook) |
| 179 | +* [AIML API Documentation](https://docs.aimlapi.com) |
| 180 | +* [OpenClaw Discord Community](https://discord.gg/clawd) |
0 commit comments