The auto-sync documentation platform
Generated from your GitHub repo, hosted at your custom domain, and always in sync with every commit
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
From draft to published
In one workflow
Editor, AI, theming, hosting, integrations — built into one platform so you ship without juggling tools
Writers and engineers, finally on the same page
Non-technical teammates edit in a visual interface. Developers switch to MDX. Highlight any paragraph and AI rewrites it inline — no leaving the page. Autosave + version history keep your cursor where it was.
- Visual editor for writers — never touch markdown
- MDX view for engineers — full control when you need it
- Highlight → AI rewrites, shortens, clarifies, or translates inline
- Per-page AI chat: "add a code example," "simplify for beginners"
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
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
Roll back like it's just code
Every documentation change is snapshotted to a Git repository you control. Browse a full timeline of edits, restore any prior state in one click — and walk away whenever you want, with your content in human-readable Markdown.
- Snapshots to a Git repo you own — not GitDocAI's storage
- One-click restore to any historical version
- Diff between snapshots like any git client
- Human-readable Markdown / MDX — zero vendor lock-in
Three steps to live
documentation
Stop spending weeks writing docs. Go from raw content to published documentation in minutes.
Welcome to Acme SDK.
Pick how you want to get started
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.
No per-seat pricing
Invite your whole team — editors, writers, reviewers, viewers, freelancers, contractors. Pay for the platform, not for each chair. Onboarding a new hire never bumps your bill or unlocks a paywall they hit on day one.
GDPR-ready & encrypted
Data encrypted in transit with TLS 1.3 and at rest with AES-256. Drafts are private by default — visible only to your team until you publish. Audit logs for every change, with data residency options for teams that need them.
Zero lock-in
Export every page as Markdown or MDX in one click, or back the whole doc up to a Git repository you own. The content is yours from day one — leave whenever you want and take everything with you, formatting and history included.
Your data is yours
We build on foundation models from Anthropic, OpenAI and others — your content is never used to train them, ours or theirs. No vendor scraping, no shared corpus, no derivative datasets. Just your team writing for your users.
Frequently asked
questions
Can't find what you're looking for? Reach out →
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