✦ Powered by Claude AI

Generate code documentation
from any GitHub repo

One API call. Get back a production-ready README, API reference, or full documentation set — structured, accurate, and ready to ship.

Try for free on RapidAPI → See example output
3
Output formats
5
Free scans/month
24h
Result caching
<15s
Average response time

One request. Complete docs.

Send a GitHub URL, get back structured Markdown documentation.

Request
POST /v1/generate Content-Type: application/json X-API-Key: your_key { "repo_url": "https://github.com/ owner/repo", "format": "full" }
Response (200 OK)
{ "id": "c4f2a1b9e7d3", "format": "full", "markdown": "# MyApp\n\n## Overview\n...", "token_count": 2847, "cached": false, "generated_at": "2026-03-28T..." }

Everything your docs need

Built for developers who want docs done right, not just done.

📄

README Generator

Produces a complete README with overview, installation, usage examples, configuration, and badges — all accurate to your actual code.

📡

API Reference

Documents every public endpoint, function, or class with parameters, return types, and example calls extracted from source code.

🗺️

Architecture Overview

Explains the module structure, design patterns, data flow, and key dependencies — the "how does this work" guide for new contributors.

24-Hour Caching

Results are cached by repo + ref combination. Repeated calls for the same commit return instantly at no extra cost.

🔑

API Key Tiers

Free tier for evaluation. Paid tiers via RapidAPI for production use with higher monthly scan limits.

🌐

Any Public GitHub Repo

Works with any language — JavaScript, Python, Go, Rust, Java, Ruby, and more. Intelligently filters binary and generated files.

Three output formats

Choose what you need or get everything at once.

# MyApp ## Overview MyApp is a lightweight Express API for managing user authentication and session tokens. Built with Node.js and PostgreSQL. ## Installation npm install cp .env.example .env npm run migrate npm start ## API Reference POST /auth/login — Authenticate user, returns JWT token POST /auth/refresh — Refresh access token using refresh token DELETE /auth/logout — Invalidate session ...full documentation continues...

Built for real workflows

From solo devs to teams automating their doc pipeline.

🤖

CI/CD Doc Pipeline

Automatically regenerate docs on every merge to main. Push to GitHub Pages or your docs site without manual effort.

🧰

GitHub Action

Drop a one-line workflow into any repo to keep documentation in sync with your code, automatically.

🏗️

Internal Tool Docs

Generate docs for internal tools that never had any — without asking engineers to write them manually.

🔌

Developer Portal

Add documentation generation to your dev portal or dashboard. Let users generate docs for their own repos.

Simple, usage-based pricing

Start free. Scale as you grow.

Free
$0 /month
No API key required
  • 5 scans / month (IP-limited)
  • All 3 output formats
  • 24h caching
  • Public repos only
Try the API
Ultra
$29 /month
Via RapidAPI
  • 500 scans / month
  • All Pro features
  • Higher rate limits
  • Priority support
Get API Key

Frequently asked questions

What does the Code Docs API actually do?
It clones your GitHub repo's file tree, filters to code files only, and passes them to Claude AI with a structured documentation prompt. You get back a Markdown string — README, API reference, or a full set — that reflects your actual code.
How is this different from using ChatGPT directly?
Code Docs API is a purpose-built REST endpoint with smart file filtering, caching, rate limiting, and structured output. You don't manage prompts, context windows, or API keys for the AI — you just send a repo URL and get Markdown back. Designed for integration into CI/CD pipelines and developer tools.
Which languages are supported?
Any language with code in a public GitHub repository — JavaScript, TypeScript, Python, Go, Rust, Java, Ruby, PHP, C#, C++, and more. The AI understands language structure and produces accurate docs regardless of stack.
How accurate are the generated docs?
Very high accuracy on public function signatures, exports, and class structures that are present in the code. The AI reads your actual source, not a description. Complex business logic may need human review, but structure, parameters, and examples are reliable.
Can I use this in a GitHub Action?
Yes. A GitHub Action wrapper is coming soon. For now, any step that runs curl or fetch can call the API and commit the result back to your repo on every push.
Is my code sent to a third party?
File contents from public GitHub repos are fetched via GitHub's API and processed through Claude AI. Only public files are read. No data is stored beyond the 24-hour response cache.

Stop writing docs by hand.

Your code already knows what it does. Let it tell you.

Get started free on RapidAPI →