What is ScopeDocs?
ScopeDocs unifies GitHub, Slack, Linear, and Supabase into one AI knowledge base for engineering documentation. It builds source-linked docs and answers grounded in your live codebase and workflow, so your documentation stays current as you ship.
Instead of scattered PRs, tickets, chat threads, and schema changes, ScopeDocs gives your team a single source of truth that evolves as you build. Every answer can be traced back to the underlying source material.
The Public API
The ScopeDocs Public API (/api/v1) gives you programmatic access to the verified context ScopeDocs has indexed across your workspace:
- Source-linked documentation — list, search, and retrieve generated docs
- Knowledge graphs — nodes, relationships, and full graph data per repo
- Pull request context — synced from GitHub with AI explanations
- Grounded chat — ask questions about your codebase in natural language
Note:The public API is designed for agents, CI pipelines, and internal tooling. Authentication uses API keys — not user sessions. Learn how to create an API key →
Available Endpoints
| Endpoint | Scope | Description |
|---|---|---|
GET /api/v1/docs | docs:read | List generated docs |
GET /api/v1/docs/search | docs:read | Vector search over docs |
GET /api/v1/docs/{id} | docs:read | Get full doc content |
GET /api/v1/graph/repos | graph:read | List indexed repos |
GET /api/v1/graph/node/{id} | graph:read | Get a graph node |
GET /api/v1/graph/{repo} | graph:read | Full knowledge graph |
GET /api/v1/prs/{repo}/{n} | prs:read | Get PR + AI explanation |
POST /api/v1/chat | chat | RAG chat over your codebase |
Base URL
All API requests are made to:
https://scopedocs-ai-production.up.railway.app