Ship production-ready
docs in minutes
Point GitDocAI at your GitHub repo, PDFs, or recordings. Our AI drafts complete documentation — styled, searchable, and ready to publish on your own domain.
REST API Architecture
A complete reference for the REST endpoints exposed by the platform, including authentication, request shapes, and response codes.
Note
All endpoints require an Authorization header with a valid bearer token.
Overview
The Acme SDK exposes a RESTful API built on microservices, using event-driven communication between components. Each module operates independently while sharing a unified data layer through PostgreSQL and OpenSearch.
Architecture
The architecture follows a clean separation between the control plane and the data plane, connected via asynchronous message queues.
services: correlation-engine: image: acme/correlation:latest ports: ["9090:9090"] agent-manager: image: acme/agent-manager:latest depends_on: [correlation-engine]
Core Components
- Correlation Engine — processes and correlates events in real-time
- Agent Manager — orchestrates distributed agents across the fleet
- Data Store — persistent storage with OpenSearch indexing
Data Flow
Events enter through the ingestion layer, are normalized by agents, correlated by the engine, and finally persisted in both the transactional database and the search index.
| Component | Protocol | Port |
|---|---|---|
| Correlation Engine | gRPC | 9090 |
| Agent Manager | HTTP/2 | 8080 |
| Data Store | TCP | 5432 |
Scaling considerations
Each service scales horizontally. The correlation engine is stateless, so you can add replicas behind a load balancer.
Trusted by teams at
“Turning threat intel write-ups into public docs used to eat a full engineer-day. Now our analysts publish directly — from draft to live in under an hour.”
“Our threat intel API had 40+ endpoints undocumented. GitDocAI pulled them from our OpenAPI spec and generated the reference in minutes — and it stays in sync as we ship.”
“We run docs for our SOC analysts internally and for customers externally. GitDocAI lets us maintain both from one source — no copy-paste, no version drift.”
Everything you need.
Nothing you don't.
Stop duct-taping four tools together. GitDocAI replaces your writer, your designer, and your docs hosting — all in one workflow.
Writers and engineers, finally on the same page
Non-technical teammates edit docs in a visual interface. Developers switch to MDX code view. Everyone ships from one source of truth — no more copy-paste between Notion and your repo.
- Drag-and-drop components so writers never touch markdown
- MDX view for engineers who want full control
- Autosave keeps your cursor where it was — never lose work mid-flow
- Keyboard shortcuts for everything — ship at the speed of thought
Your AI co-writer, from first draft to final polish
Point GitDocAI at your repo, PDFs, or a Loom recording — it drafts complete pages from scratch. Highlight any paragraph and AI rewrites, shortens, or translates it. Bulk on day one, inline every day after.
- Generates full docs from repos, PDFs, OpenAPI, audio & video — live progress
- Highlight any text → AI rewrites, shortens, clarifies, or translates it
- Chat with AI per page: "add a code example," "simplify for beginners"
- Every AI output stays editable — you always keep the final word
Add resources
Content sources for "Getting Started" — AI uses these to generate accurate docs.
Looks like your product. Not like a template.
Ship docs that reinforce your brand — not a generic hosted page. Your colors, your fonts, your domain, your SSL. Your customers should never know it isn't custom-built.
- One-click brand themes with live preview before publishing
- Any font from Google Fonts — match your marketing site exactly
- Upload logo & favicon in seconds
- Custom domain (docs.yourcompany.com) with automatic SSL
Introduction
The Acme SDK gives you everything you need to build agents that monitor and automate your infrastructure — with a single authenticated API.
Good to know
You'll need an API key from your dashboard before you can authenticate.
Prerequisites
- Node.js 18 or later
- An Acme account with API access
API docs without the grind
Drop an OpenAPI spec — get endpoint pages, schemas, and examples your developers will actually read.
Your whole team, zero chaos
Admin, editor, viewer roles keep writers moving fast without giving everyone the keys to production.
Always in sync with your code
Connect your repo once. Every push updates your docs automatically — no more stale pages.
Three steps to live
documentation
Stop spending weeks writing docs. Go from raw content to published documentation in minutes.
Add resources
Content sources for "Getting Started" — AI uses these to generate accurate docs.
Built for teams that ship.
Priced for teams that care.
Everything you need to go from raw content to published docs — without enterprise pricing, seat taxes, or lock-in games.
AI that actually writes
Not just autocomplete — full page generation from your repo, PDFs, or videos.
15+ import sources
GitHub, PDFs, OpenAPI, websites, audio, video. One workflow, any input.
Custom domain from $12/mo
Your brand, your domain, automatic SSL — no enterprise-tier upsell.
No per-seat pricing
Invite your whole team. Editors, writers, reviewers — all included.
Zero lock-in
Export everything as Markdown or MDX any time. Your content stays yours.
Lifetime deal available
Pay once, own it forever. Lock in your plan with no recurring fees.
GDPR-ready & encrypted
Data encrypted in transit and at rest. Your drafts are private by default.
Your data never trains our models
We build on foundation models — your content is yours alone.
Pricing that grows
with you
Start free. Upgrade when your docs start driving signups. No hidden fees, no per-seat nonsense.
Save up to 20% with annual plans
Your docs can be live
by tomorrow.
Stop pretending you'll write them “next sprint.” Import your content, let AI do the heavy lifting, and ship docs your users will actually read.
Free forever plan · 15-day trial on paid plans · Cancel anytime