docs: add /docs API reference for AI agents#6
Merged
Conversation
added 5 commits
April 25, 2026 13:32
…aces, objects, connections, diagrams, technologies, webhooks, realtime, misc)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
/docsroute on the frontend with a curated, agent-focused API reference covering auth, API keys, workspaces, objects, connections, diagrams, technologies, webhooks, realtime WebSocket, plus a roll-up of secondary endpoints (drafts, comments, activity, versions, members/invites, teams, packs, diagram access, flows, export, notifications).docs/api/so it's also consumable directly from the repo (one file per section + an index).LegalLayoutaesthetic with a sticky table of contents onlg+breakpoints, anEndpointcard primitive (color-coded methods), and aCodeBlockprimitive.Test plan
npm run buildinfrontend/passes (tsc -b && vite build— production build succeeds, no TypeScript errors).python -m pytestinbackend/: the same 64 tests pass and 55 tests fail as onmain. All failures are environment-only (Redis onlocalhost:6379+ Postgres not running in the local sandbox); they reproduce identically onmainat HEAD before any of these changes. The repo's CI workflow does not run pytest, only Docker image builds — so this PR does not introduce any test regressions vs.main./docsin dev to spot-check rendering and anchor links.Notes for reviewers
/docsroute is public (no<ProtectedRoute>wrap) so AI agents can read the reference before authenticating, mirroring how/termsand/privacyare exposed.