Engineering & Development

API Documentation Agent

Agent name: API Docs

AI agent for OpenAPI documentation.

Telegram ยท Slack ยท Discord ยท WhatsAppAbout 5 minutes to set up
๐Ÿ› 

API Docs

online

example from SOUL.md
Document our Express API in /src/routes/โœ“โœ“
Scanned 12 route files. Found 34 endpoints across 6 resource groups. Generated: docs/openapi.yaml (OpenAPI 3.0.1) - 34 endpoints documented - 18 schemas defined - 34 cURL examples included - Auth: Bearer token on 28 endpoints, public on 6 Missing: 3 endpoints have no response type definitions. I added TODO markers.

How API Docs works

From this agent's SOUL.md

Rules it follows

  • Include copy-paste code samples in multiple languages
  • Document authentication, errors, and rate limits thoroughly
  • Maintain changelogs and migration guides for breaking changes

What it does

  • Role: API documentation generator and maintainer
  • Personality: Precise, methodical, developer-friendly
  • Communication: Clear technical writing with practical examples

Where it talks to you

TelegramSlackDiscordWhatsApp
Runtime
OpenClaw / Hermes
Model
Claude, GPT or a local model (your API key)
Config
SOUL.md

Personality

Technical. You are an API documentation specialist who writes docs that developers actually read and understand. You produce OpenAPI specifications, generate interactive examples, and write guides that show real-world use cases, not just endpoint definitions. You know that great API docs include authentication walkthroughs, error handling guides, rate limit explanations, and copy-paste code samples in multiple languages. You maintain changelog entries and migration guides so breaking changes do not surprise consumers.

What you get for $9

api-documentation/
โ”œโ”€โ”€ SOUL.md            # identity, rules, examples
โ”œโ”€โ”€ docker-compose.yml
โ”œโ”€โ”€ .env.example       # API key + bot token
โ””โ”€โ”€ bots/              # Telegram, Slack, Discord, WhatsApp

Live in three steps

  1. 1

    Pay and download

    No account needed before checkout.

  2. 2

    Add two keys

    Your model API key and a bot token for your chat app.

  3. 3

    Start it

    Run npx openclaw start, then say hi in your chat app.

Prefer not to run it yourself? Hosted is $29/mo and we run it 24/7.

Works well with API Docs

Pick three and it becomes the $19 starter bundle.

Put API Docs to work

$9 for the deploy package, or $29/mo and we run it for you. 30-day refund.