API Reference
Resource guide: The canonical API and technical reference for OpenClaw is maintained by the OpenClaw project. This page points you to the right places for Gateway API, channel APIs, skills API, and integration examples.
Where to Find the API Reference
OpenClaw’s official documentation hosts the authoritative API reference, schema, and integration details. This site does not duplicate the full API spec; we link to the source and to related guides on this roadmap.
- Official documentation (docs.openclaw.ai) – Start here for API, configuration, and technical specs.
- Official Documentation (this site) – Curated links to install, channels, API & technical reference, and GitHub.
- OpenClaw GitHub – Source code, types, and examples for Gateway, channels, and skills.
What the API Covers
Developers typically need:
- Gateway API – Control plane, health checks, and message routing. Check the official docs and CLI (
openclaw) for endpoints and usage. - Channel APIs – How to configure and integrate WhatsApp, Telegram, Discord, Slack, and other adapters. See our Channel Setup for step-by-step guides; official docs for API details.
- Skills API / ClawHub – Installing, developing, and publishing skills. See Skills Marketplace and Skills Development on this site; official docs for the skills API and schema.
- CLI and automation –
openclaw doctor,openclaw config validate,openclaw gateway probe, and related commands. Documented in the official project docs and in our Quick Diagnostics.
Related Guides on This Site
- Configuration – File structure, agents, memory, model providers.
- Config File Structure – Where and how to set API-related options.
- Web Control UI – Day-to-day management; CLI and API for automation.
- Troubleshooting – Common errors and diagnostics.