Skip to content
D
Documentation

All operations

Every operation in the published specification, listed so it can be read without running the explorer above.

nestjs

  • GET/— health
  • GET/info— Service info endpoint
  • GET/stats— getPublicStats
  • GET/assets— listAssets
  • POST/events— Record an interaction event (feedback, search miss, …)
  • GET/health— health
  • GET/search— Search documentation
  • GET/auth/me— Get current user information
  • GET/parsers— List supported parsers
  • POST/analysis— Start a new code analysis job
  • GET/projects— List all projects in the user's organization
  • POST/projects— Create a new project
  • GET/audiences— List all audiences (standard + organization-specific)
  • POST/audiences— Create a new organization-specific audience
  • GET/audit/org— Query the org-wide audit trail (admins/maintainers)
  • GET/documents— List documents
  • POST/documents— Create a new document
  • GET/templates— List templates
  • POST/templates— Create a new template
  • GET/activities— List activities with filters
  • POST/ai/enhance— Enhance document with AI suggestions
  • POST/ai/improve— Improve writing quality
  • POST/ai/outline— Generate document outline
  • GET/categories— List categories
  • POST/categories— Create a new category
  • POST/csp-report— report
  • POST/screenshot— Take a single screenshot
  • GET/assets/{id}— getAsset
  • DELETE/assets/{id}— deleteAsset
  • POST/auth/logout— Logout user
  • GET/screenshots— List screenshots
  • POST/screenshots— Capture a screenshot
  • GET/suggestions— list
  • POST/suggestions— create
  • GET/agent/status— Health check / session stats for monitoring.
  • GET/ai/providers— List available AI providers
  • POST/ai/summarize— Summarize document
  • POST/auth/refresh— Refresh access token
  • POST/git/branches— List repository branches via git ls-remote
  • GET/github/repos— List repositories from the connected GitHub account
  • GET/gitlab/repos— List repositories from the connected GitLab account
  • GET/ops/overview— Operational overview: jobs, AI spend, credits, chat deflection, queues
  • POST/parser/parse— Parse code and extract symbols
  • POST/pme/finalize— Finalize page with chosen variants
  • POST/pme/generate— Create PME generation job
  • POST/pme/strategy— Start strategy session
  • GET/ai/usage/logs— List raw AI usage rows for the organization (paginated)
  • POST/assets/upload— uploadImage
  • POST/auth/register— Register a new user
  • GET/github/status— Check GitHub connection status
  • GET/gitlab/status— Check GitLab connection status
  • GET/manual-videos— List page videos for a project
  • GET/notifications— List the caller's notifications (newest first, paginated, ?unreadOnly=true to filter)
  • GET/organizations— List organizations (returns current user's organization)
  • GET/platform/orgs— List/search organizations (platform admin).
  • GET/projects/{id}— Get project by ID
  • PUT/projects/{id}— Update project (PUT)
  • PATCH/projects/{id}— Update project
  • DELETE/projects/{id}— Delete project
  • POST/public/issues— Submit an issue report (public, no auth)
  • GET/scim/v2/Users— list
  • POST/scim/v2/Users— create
  • GET/search/health— Health check for search service
  • GET/audiences/{id}— Get audience by ID
  • PATCH/audiences/{id}— Update an existing audience
  • DELETE/audiences/{id}— Delete an audience
  • GET/billing/portal— Create a Stripe Billing Portal session
  • POST/discovery/scan— POST /api/discovery/scan
  • GET/documents/{id}— Get a document by ID
  • PATCH/documents/{id}— Update a document
  • DELETE/documents/{id}— Delete a document
  • GET/scim/v2/Groups— list
  • POST/scim/v2/Groups— create
  • POST/screenshot/pdf— Render composed HTML to a PDF binary.
  • GET/templates/{id}— Get a template by ID
  • PATCH/templates/{id}— Update a template
  • DELETE/templates/{id}— Delete a template
  • POST/trial/generate— Generate a docs hub for a public GitHub repo — no signup
  • POST/analytics/track— Track analytics event (public, no auth required)
  • GET/billing/summary— Plan, credit balance and current-month usage summary
  • POST/billing/webhook— Stripe webhook receiver (signature-verified raw body)
  • GET/bitbucket/repos— listRepos
  • GET/categories/{id}— Get a category by ID
  • PATCH/categories/{id}— Update a category
  • DELETE/categories/{id}— Delete a category
  • GET/dashboard/stats— Get dashboard statistics
  • GET/github/auth-url— Get the GitHub OAuth authorization URL
  • GET/github/callback— GitHub OAuth callback - exchanges code for token
  • GET/gitlab/auth-url— Get the GitLab OAuth authorization URL
  • GET/gitlab/callback— GitLab OAuth callback - exchanges code for token
  • GET/public/projects— List all published projects (for sitemap generation)
  • GET/scim/v2/Schemas— schemas
  • POST/screenshot/flow— Create and start a flow-replay job (WS-A)
  • POST/webhooks/github— GitHub webhook receiver (no auth — verified by HMAC)
  • POST/webhooks/gitlab— GitLab webhook receiver (no auth — verified by token)
  • GET/analysis/{jobId}— Get analysis job status
  • GET/audit/org/facets— Distinct actions + actors for the org audit filters
  • GET/auth/saml/config— Get the org SAML configuration (certificate hidden)
  • PUT/auth/saml/config— Upsert the org SAML configuration
  • POST/billing/checkout— Create a Stripe Checkout Session for a plan upgrade
  • GET/bitbucket/status— getStatus
  • GET/documents/search— Search documents
  • GET/parser/languages— Get supported programming languages
  • GET/pme/jobs/{jobId}— Get PME job status
  • POST/screenshot/batch— Create and start a batch screenshot job
  • POST/screenshots/bulk— Bulk capture screenshots
  • GET/screenshots/jobs— List screenshot jobs
  • GET/screenshots/{id}— Get screenshot
  • DELETE/screenshots/{id}— Delete screenshot
  • GET/suggestions/{id}— getById
  • DELETE/suggestions/{id}— delete
  • GET/users/{id}/posts— Get user posts
  • GET/audit/{projectId}— Query audit trail for a project
  • GET/auth/sso/discover— Discover an SSO-enabled org for an email domain
  • POST/auth/sso/exchange— Exchange a one-time SSO code for tokens (single use)
  • POST/auth/verify-email— Verify email address with the emailed token
  • POST/github/disconnect— Disconnect GitHub from user account
  • POST/gitlab/disconnect— Disconnect GitLab from user account
  • POST/analytics/feedback— Submit helpfulness feedback (public, no auth)
  • GET/bitbucket/auth-url— getAuthUrl
  • GET/bitbucket/callback— handleCallback
  • POST/categories/reorder— Reorder categories
  • GET/dashboard/activity— Get user activity statistics
  • GET/dashboard/projects— Get project statistics for dashboard
  • GET/manual-videos/{id}— Get one page video (script + chapters)
  • GET/organizations/{id}— Get organization by ID
  • PATCH/organizations/{id}— Update organization
  • POST/projects/sync/full— Start full background sync job
  • GET/projects/sync/jobs— Get all sync jobs for organization
  • GET/scim/v2/Users/{id}— get
  • PUT/scim/v2/Users/{id}— replace
  • PATCH/scim/v2/Users/{id}— patch
  • DELETE/scim/v2/Users/{id}— remove
  • GET/search/suggestions— Get autocomplete suggestions
  • POST/templates/{id}/use— Create a document from a template
  • POST/auth/reset-password— Reset password with the emailed token
  • GET/doc-automation/jobs— List documentation jobs
  • POST/doc-automation/jobs— Start documentation job
  • POST/documents/bulk/move— Bulk move documents to a category
  • POST/git/test-connection— Test repository access with credentials
  • GET/invitations/{token}— Get public invitation info by token
  • GET/projects/{id}/stats— Get project statistics
  • GET/public/tours/config— Matched LIVE adoption experiences for a page (public, no auth)
  • POST/public/tours/events— Record a tour widget event (public, sendBeacon-compatible)
  • GET/scim/v2/Groups/{id}— get
  • PATCH/scim/v2/Groups/{id}— patch
  • POST/webhooks/github-app— GitHub App webhook (installation lifecycle + push)
  • GET/audit/org/export/csv— Export the org-wide audit trail as CSV (or JSON via ?format=json)
  • POST/auth/forgot-password— Request a password reset email
  • POST/bitbucket/disconnect— disconnect
  • GET/documents/{id}/stats— Get document statistics
  • GET/knowledge-graph/path— Find shortest path between two entities
  • GET/public/domain/{host}— Resolve a live custom domain to its published project
  • POST/screenshot/page-html— Get rendered page HTML (JS-rendered DOM) for AI analysis
  • GET/users/{id}/followers— Get user followers
  • POST/api/orchestrator/jobs— Dispatch a parse job
  • POST/doc-automation/config— Create automation config
  • POST/documents/bulk/delete— Bulk delete documents
  • GET/documents/{id}/render— Render document with audience filtering
  • GET/platform/orgs/{orgId}— Organization detail (plan, override, SSO summary).
  • GET/projects/{id}/members— Get project members
  • POST/projects/{id}/members— Add member to project
  • POST/projects/{id}/publish— Publish a project for public access
  • GET/public/documents/{id}— Get a published document (public access)
  • GET/public/p/{slugWithId}— Get public project by URL
  • GET/scim/v2/ResourceTypes— resourceTypes
  • POST/screenshot/responsive— Take responsive screenshots (mobile, tablet, desktop)
  • POST/screenshot/smart-auth— Smart authenticated screenshot - AI auto-detects login form selectors
  • GET/screenshots/jobs/{id}— Get screenshot job
  • POST/webhooks/azure-devops— Azure DevOps webhook receiver (Basic Auth verified)
  • POST/documents/bulk/publish— Bulk publish all documents in a project
  • GET/documents/{id}/compare— Compare document versions or revisions
  • POST/documents/{id}/publish— Publish a document
  • GET/knowledge-graph/search— Search entities
  • POST/notifications/read-all— Mark all of the caller's notifications as read
  • GET/projects/{id}/settings— Get project settings
  • PATCH/projects/{id}/settings— Update project settings
  • GET/public/tours/checklist— Get a visitor’s persisted checklist progress (public, no auth)
  • POST/public/tours/checklist— Persist a checklist item toggle for a visitor (public)
  • PUT/sdk/{projectId}/config— Set enabled SDK languages (typescript is always on)
  • GET/sdk/{projectId}/status— SDK languages, spec quality and per-language generation status
  • GET/api/orchestrator/health— Health check
  • POST/auth/saml/config/toggle— Enable or disable the SAML connection
  • GET/desk/{projectId}/counts— Desk bucket counts (sidebar badges, done-today, unassigned)
  • GET/docs-pr/{projectId}/prs— listPrs
  • POST/docs-pr/{projectId}/run— Manually run the freshness-PR flow now (for testing / on-demand).
  • GET/documents/{id}/versions— List named versions
  • POST/documents/{id}/versions— Create a named version
  • PATCH/notifications/{id}/read— Mark one notification as read (owner-scoped, 404 otherwise)
  • GET/projects/{id}/audiences— Get audiences with published document counts for a project
  • PATCH/projects/{id}/subdomain— Set or rename the project public subdomain slug
  • POST/projects/{id}/unpublish— Unpublish a project making it private
  • GET/public/doc/{slugWithId}— Get public document by URL (general audience)
  • GET/public/subdomain/{slug}— Get public project by subdomain slug
  • POST/screenshot/flow/locales— Locale-fanned reshoot (F2 SUPERIOR, synchronous)
  • POST/screenshot/flow/reshoot— Re-shoot ONE step of a recipe (F2, synchronous)
  • POST/suggestions/{id}/accept— accept
  • POST/suggestions/{id}/reject— reject
  • POST/trial/{projectId}/claim— Claim a trial project into the logged-in user’s organization
  • GET/activities/projects/{id}— Get activities for a specific project
  • GET/api/orchestrator/parsers— Get available parsers
  • POST/auth/resend-verification— Re-send the email-verification link for the logged-in user
  • GET/desk/{projectId}/threads— List a desk bucket (triage/needs_first/needs_next/investigating/waiting/paused/done/mine)
  • GET/doc-automation/jobs/{id}— Get documentation job
  • GET/doc-versions/{projectId}— List versions for a project
  • POST/doc-versions/{projectId}— Create a new version manually
  • POST/documents/{id}/duplicate— Duplicate a document
  • GET/documents/{id}/revisions— List document revisions
  • POST/documents/{id}/unpublish— Unpublish a document
  • POST/knowledge-graph/entities— Create entity in knowledge graph
  • POST/manual-videos/{id}/regen— Re-render the video from the edited script + cached clips (Pro+)
  • POST/screenshot/authenticated— Take authenticated screenshot (login first, then capture)
  • POST/screenshot/flow/validate— Validate (and heal) a recipe's selectors against the live app (D2 self-healing)
  • GET/trial/{projectId}/status— Trial generation status (trial projects only)
  • GET/activities/documents/{id}— Get activities for a specific document
  • GET/analytics/{projectId}/geo— Get page views grouped by country
  • POST/auth/saml/config/metadata— Import IdP metadata (URL or XML) and return parsed fields
  • GET/auth/saml/login/{orgSlug}— Initiate SP-initiated SSO login (public)
  • GET/capture/{projectId}/flows— List captured flows for a project
  • POST/capture/{projectId}/flows— Ingest a recorded flow (recipe of steps)
  • GET/content-tasks/{projectId}— List content tasks for a project (the action queue)
  • POST/content-tasks/{projectId}— Create a task from an insight (idempotent by sourceRef)
  • POST/documents/bulk/visibility— Bulk update document visibility
  • GET/knowledge-graph/flow/{id}— Detect development flow from entity
  • POST/knowledge-graph/relations— Create relationship between entities
  • PATCH/manual-videos/{id}/script— Edit the narration script (Pro+); marks the video stale
  • POST/organizations/{id}/invite— Invite a member to the organization
  • GET/platform/orgs/{orgId}/sso— View an org's SAML config for support (cert as fingerprint only).
  • PATCH/platform/orgs/{orgId}/sso— Repair an org's SAML config.
  • GET/pme/jobs/{jobId}/variants— Get variants for a job
  • GET/projects/{id}/docs-health— Consolidated docs-health summary for the owner project page
  • GET/projects/{id}/share-links— List share links (no tokens returned)
  • POST/projects/{id}/share-links— Create a share link (returns the plaintext token ONCE)
  • GET/public/capture/flows/{id}— Get a captured flow for the tour player (public, no auth)
  • GET/public/manual-videos/{id}— Resolve a public page video for embedding (no auth)
  • GET/public/p/{slugWithId}/mcp— MCP is stateless — use POST
  • POST/public/p/{slugWithId}/mcp— MCP (Streamable HTTP) endpoint for a published site — docs + entity graph
  • GET/public/p/{slugWithId}/sdk— Available SDK languages for a published project ("Get the SDK" dropdown)
  • GET/activities/recent/projects— Get recent projects for current user
  • POST/auth/saml/callback/{orgId}— SAML Assertion Consumer Service — IdP POSTs here (public)
  • GET/auth/saml/{orgId}/metadata— Per-org SP metadata for IdP configuration (public)
  • GET/docs-pr/{projectId}/config— getConfig
  • PUT/docs-pr/{projectId}/config— setConfig
  • GET/documents/tree/{projectId}— Get document tree for a project
  • POST/invitations/{token}/accept— Accept an invitation — creates the account (new invitee) or attaches an existing one to the organization
  • GET/knowledge-graph/statistics— Get knowledge graph statistics
  • GET/organizations/{id}/members— Get organization members
  • POST/parser/document/{id}/parse— Parse all code blocks in a document
  • PATCH/platform/orgs/{orgId}/plan— Set an org plan and/or grant an auto-expiring plan override.
  • GET/projects/sync/jobs/{jobId}— Get sync job status
  • GET/projects/{projectId}/parse— Get all parsing jobs for a project
  • POST/projects/{projectId}/parse— Start parsing a project
  • POST/sdk/{projectId}/regenerate— Force re-generation of every enabled SDK for the current spec
  • GET/activities/recent/documents— Get recent documents for current user
  • GET/categories/tree/{projectId}— Get category tree structure for a project
  • GET/freshness/{projectId}/stale— Owner: pages that went stale when this project's code changed (+ the commit)
  • GET/knowledge-graph/impact/{id}— Detect impact of changes to entity
  • GET/organizations/{id}/settings— Get organization settings
  • PATCH/organizations/{id}/settings— Update organization settings
  • GET/projects/{id}/access-policy— Get the access policy for a project (password hidden)
  • PUT/projects/{id}/access-policy— Update the access policy (bumps tokenVersion on mode/password change)
  • GET/projects/{id}/custom-domain— Get the custom domain (null when none configured)
  • POST/projects/{id}/custom-domain— Connect a custom domain (returns the DNS records to create)
  • DELETE/projects/{id}/custom-domain— Remove the custom domain (warns if DNS still points at Atloria)
  • POST/projects/{id}/preview-token— Mint a short-lived "Preview as…" reader token with arbitrary claims
  • GET/projects/{projectId}/boards— List boards for a project
  • POST/projects/{projectId}/boards— Create a new board
  • GET/projects/{projectId}/issues— List issues with filters & pagination
  • GET/analysis/project/{projectId}— Get all analysis jobs for a project
  • POST/analytics/{projectId}/export— Generate a one-off PDF or CSV analytics export
  • GET/audit/{projectId}/export/csv— Export audit trail as CSV
  • GET/changelog/{projectId}/config— Changelog settings + subscriber counts
  • PUT/changelog/{projectId}/config— Update changelog settings (auto-publish toggle)
  • GET/projects/{id}/devhub/readers— Developer signups list (paginated, newest first)
  • GET/projects/{id}/devhub/summary— Developer-hub summary: signups, TTFC funnel, top consumers
  • GET/public/p/{slugWithId}/search— Full-text search across published project docs (public)
  • POST/templates/from-document/{id}— Save a document as a template
  • GET/analytics/{projectId}/devices— Get page views grouped by device class
  • GET/analytics/{projectId}/reports— List scheduled reports for a project
  • POST/analytics/{projectId}/reports— Create a scheduled report
  • GET/analytics/{projectId}/sources— Get page views grouped by normalized referrer source
  • DELETE/api/orchestrator/jobs/{jobId}— Cancel a job
  • GET/audit/{projectId}/export/json— Export audit trail as JSON
  • GET/changelog/{projectId}/entries— List changelog entries (drafts inbox + published history)
  • POST/changelog/{projectId}/entries— Create a manual changelog entry (draft)
  • GET/desk/{projectId}/threads/{id}— One thread with the full timeline (comments + activities)
  • POST/freshness/{projectId}/reshoot— Owner: re-shoot the screenshots behind the stale manual pages (scoped atlorix capture run)
  • GET/knowledge-graph/entities/{id}— Get entity by ID
  • DELETE/knowledge-graph/entities/{id}— Delete entity from knowledge graph
  • GET/pme/projects/{projectId}/jobs— List PME jobs for a project
  • GET/projects/{id}/reader-identity— Get the reader-identity config (secret never returned)
  • PUT/projects/{id}/reader-identity— Update reader identity (enable, mode, JWKS URL, claimMap, rotate secret)
  • GET/projects/{id}/subdomain/check— Check whether a desired subdomain slug is available
  • GET/projects/{projectId}/branding— Get current branding for a project
  • PATCH/projects/{projectId}/branding— Update (upsert) branding for a project
  • GET/projects/{projectId}/entities— Get all entities for a project
  • GET/projects/{projectId}/git-sync— Read the project docs↔GitHub sync config + cursors/status
  • PUT/projects/{projectId}/git-sync— update
  • GET/projects/{projectId}/snippets— List snippets for a project
  • POST/projects/{projectId}/snippets— Create a snippet
  • GET/public/p/{slugWithId}/related— Get related ("See also") documents for a published document
  • GET/scim/v2/ServiceProviderConfig— serviceProviderConfig
  • POST/screenshot/validate-selectors— validateSelectors
  • GET/tours/{projectId}/experiences— List a project’s adoption experiences
  • POST/tours/{projectId}/experiences— Create an adoption experience (tour/checklist/announcement/nps)
  • GET/analytics/{projectId}/overview— Get analytics overview
  • GET/analytics/{projectId}/versions— Get per-version traffic
  • GET/api/orchestrator/queue/metrics— Get queue metrics
  • GET/capture/{projectId}/flows/{id}— Get a captured flow with its full step list (editor)
  • DELETE/capture/{projectId}/flows/{id}— Delete a captured flow
  • GET/organizations/{id}/scim-status— SCIM sync status: tokens, provisioned counts, recent events
  • GET/organizations/{id}/scim-tokens— List SCIM tokens (never returns the secret)
  • POST/organizations/{id}/scim-tokens— Mint a SCIM token (plaintext returned exactly once)
  • PATCH/projects/{id}/members/{userId}— Update member role
  • DELETE/projects/{id}/members/{userId}— Remove member from project
  • GET/projects/{id}/visibility-rules— List documents/categories that carry a visibility rule
  • GET/public/p/{slugWithId}/api-spec— Get OpenAPI spec for a published project (public)
  • GET/public/p/{slugWithId}/llms.txt— llms.txt index for a published site (technical + user manuals)
  • GET/public/p/{slugWithId}/versions— Get published versions for version switcher
  • POST/technical-docs/{projectId}/ask— Grounded chat: ask a question about the codebase (cited answer)
  • GET/technical-docs/{projectId}/mcp— mcpGet
  • POST/technical-docs/{projectId}/mcp— MCP (Streamable HTTP) endpoint for a project's technical docs
  • GET/analytics/{projectId}/documents— Get top documents
  • GET/api/orchestrator/parsers/detect— Determine which parser to use for a file
  • POST/api/orchestrator/projects/parse— Parse an entire project
  • POST/doc-automation/jobs/{id}/cancel— Cancel documentation job
  • GET/doc-versions/{projectId}/active— Get the active version for a project (per doc-set scope; default 'user')
  • GET/documents/{documentId}/comments— List comments
  • POST/documents/{documentId}/comments— Create a comment
  • POST/documents/{id}/revert/{version}— Revert to a previous version
  • PATCH/pme/variants/{variantId}/select— Select a variant
  • GET/public/p/{slugWithId}/audiences— Get audiences for a published project
  • GET/public/p/{slugWithId}/changelog— Published changelog entries for a public project
  • GET/public/p/{slugWithId}/languages— Get published languages for the locale switcher
  • GET/screenshot/batch/{jobId}/status— Get batch job status and results
  • POST/technical-docs/{projectId}/jobs— Start technical docs generation for a project
  • GET/analytics/{projectId}/ghost-docs— Get published documents with zero page views in the last N days
  • GET/doc-versions/{projectId}/compare— Compare two doc versions
  • POST/documentation/generate-user-docs— Generate AI-powered user documentation
  • GET/projects/{projectId}/docs-config— get
  • PATCH/projects/{projectId}/docs-config— set
  • PATCH/projects/{projectId}/issues/bulk— Bulk update multiple issues
  • GET/public/p/{slugWithId}/access/sso— Start SSO reader login — 302 to the org IdP (reader mode)
  • GET/public/p/{slugWithId}/export/pdf— Download the served doc set as a branded PDF (PRO+; cached per version)
  • GET/support-agent/{projectId}/agents— List all agents for a project
  • POST/support-agent/{projectId}/agents— Create a new agent
  • GET/support-agent/{projectId}/config— Get support agent config for a project
  • PUT/support-agent/{projectId}/config— Create or update support agent config for a project
  • GET/support-agent/{projectId}/search— Scoped RAG search for support agent
  • GET/content-tasks/{projectId}/members— List org members for the assignee picker
  • GET/doc-automation/config/{projectId}— Get automation config
  • PUT/doc-automation/config/{projectId}— Update automation config
  • DELETE/doc-automation/config/{projectId}— Delete automation config
  • POST/documentation/generate-from-neo4j— Generate complete documentation from Neo4j knowledge graph
  • GET/documents/{id}/versions/{version}— Get a specific version of a document
  • POST/platform/orgs/{orgId}/sso/disable— Kill-switch an org's SSO connection.
  • POST/projects/sync/jobs/{jobId}/cancel— Cancel a running sync job
  • POST/projects/{id}/custom-domain/check— Run the DNS verification check (transitions state, provisions TLS when verified)
  • POST/projects/{id}/custom-domain/retry— Retry after a failure / recover an offline domain
  • GET/projects/{projectId}/issues/stats— Get aggregate issue statistics
  • POST/public/p/{slugWithId}/access/link— Redeem a share link token for a reader token
  • GET/public/p/{slugWithId}/chat/config— Get public support agent config (name, welcome message, isEnabled)
  • GET/public/p/{slugWithId}/reader/keys— The reader's keys on this project (prefix only — never hash/plaintext)
  • POST/public/p/{slugWithId}/reader/keys— Create a reader API key — plaintext returned exactly ONCE
  • GET/public/p/{slugWithId}/screenshots— Get screenshot placeholders for a project
  • POST/technical-docs/{projectId}/enrich— AI-enrich the top-N entities in the background (batched path for large repos)
  • GET/technical-docs/{projectId}/sdk.ts— Download a typed TypeScript SDK generated from the project's API spec (Tier 3.3)
  • GET/technical-docs/{projectId}/status— Get technical docs generation status for a project
  • PATCH/analytics/{projectId}/reports/{id}— Update a scheduled report
  • DELETE/analytics/{projectId}/reports/{id}— Delete a scheduled report
  • PATCH/content-tasks/{projectId}/{taskId}— Update a task (assign / change status / retitle)
  • DELETE/content-tasks/{projectId}/{taskId}— Delete a task
  • DELETE/doc-automation/jobs/{id}/documents— Delete job documents
  • GET/documents/{documentId}/suggestions— list
  • POST/documents/{documentId}/suggestions— create
  • GET/l10n/projects/{projectId}/overview— Per-language coverage/staleness rollup for the translations cockpit
  • GET/l10n/projects/{projectId}/settings— Localization settings (glossary + auto-retranslate opt-in)
  • PUT/l10n/projects/{projectId}/settings— Update localization settings
  • DELETE/projects/{id}/share-links/{linkId}— Revoke a share link
  • POST/projects/{projectId}/entities/sync— Sync batch of knowledge graph entities from CLI
  • GET/projects/{projectId}/parse/{jobId}— Get parse job status
  • DELETE/projects/{projectId}/parse/{jobId}— Cancel a parsing job
  • GET/projects/{projectId}/relationships— Get all relationships for a project
  • GET/projects/{projectId}/snippets/{id}— Get a snippet
  • PATCH/projects/{projectId}/snippets/{id}— Update a snippet
  • DELETE/projects/{projectId}/snippets/{id}— Delete a snippet
  • GET/public/doc/{audience}/{slugWithId}— Get public document by URL with audience filter
  • POST/public/p/{slugWithId}/access/email— Request a 6-digit access code (allow-listed domains only)
  • GET/public/p/{slugWithId}/capabilities— Get available public sections for a published project
  • GET/public/p/{slugWithId}/reader/usage— TTFC checklist + daily counts + the reader's OWN request log (status/path/latency only)
  • GET/public/p/{slugWithId}/resolve-slug— Resolve a renamed page slug to its current slug (link-rot redirect)
  • GET/technical-docs/{projectId}/sources— List imported external sources
  • GET/tours/{projectId}/experiences/{id}— Get one experience (editor)
  • PATCH/tours/{projectId}/experiences/{id}— Edit an experience (content/targeting/trigger/priority)
  • DELETE/tours/{projectId}/experiences/{id}— Delete an experience
  • GET/agent-analytics/{projectId}/actions— Agent actions: live-API calls agents ran via call_operation — volume, top operations, blocked writes, error rate
  • GET/agent-analytics/{projectId}/traffic— Agent traffic: reads by AI vendor, surface, page, trend + unanswered questions
  • GET/analytics/{projectId}/daily-traffic— Get daily page views and unique visitors as a time series
  • GET/analytics/{projectId}/trending-docs— Get documents with biggest week-over-week growth or drop
  • POST/desk/{projectId}/threads/{id}/reply— Agent reply: public → PENDING (or RESOLVED with andDone); internal notes never change status
  • POST/doc-automation/jobs/{id}/run-upload— Run stage-13 upload against an existing job (atlorix-runner)
  • POST/doc-versions/{projectId}/apply-edit— Apply an edit from one document to matching docs in other versions
  • PATCH/documents/{id}/versions/{versionId}— Update version metadata
  • DELETE/documents/{id}/versions/{versionId}— Delete a named version
  • POST/projects/{projectId}/documents/sync— Sync batch of documents from CLI
  • POST/public/p/{slugWithId}/chat/escalate— Escalate a support chat to a human (create a ticket)
  • POST/public/p/{slugWithId}/chat/feedback— Record 👍/👎 feedback on a support chat answer
  • GET/public/p/{slugWithId}/llms-full.txt— Full concatenated corpus for single-ingest agents
  • GET/public/p/{slugWithId}/param-options— Candidate values for a parameter, from the spec's declared source
  • GET/technical-docs/{projectId}/api-docs— Get the generated API Reference doc set (docKind:'api') for the reader
  • GET/technical-docs/{projectId}/api-spec— Get the OpenAPI spec for the API playground
  • PUT/technical-docs/{projectId}/curation— Set curation: pinned/hidden entity ids applied to the served nav map (Phase 2.2)
  • POST/technical-docs/{projectId}/generate— Generate + materialize the technical doc set (parse → snapshot → browsable docs)
  • GET/technical-docs/{projectId}/llms.txt— Curated llms.txt index of the technical docs (for AI agents)
  • GET/technical-docs/{projectId}/snapshot— Get technical snapshot nav map for a project
  • GET/analytics/{projectId}/export-history— List recent exports for a project
  • GET/analytics/{projectId}/search-queries— Get top search queries with click-through rates
  • GET/api/orchestrator/jobs/{jobId}/result— Get job result
  • GET/api/orchestrator/jobs/{jobId}/status— Get job status
  • POST/capture/{projectId}/flows/{id}/draft— Generate a DRAFT manual page from a captured flow
  • PATCH/capture/{projectId}/flows/{id}/steps— Edit a captured flow step list (reorder/delete/caption/redact)
  • POST/doc-automation/jobs/{id}/screenshots— Trigger background screenshots
  • GET/doc-versions/{projectId}/{versionId}— Get a specific version
  • PATCH/doc-versions/{projectId}/{versionId}— Update version label/description
  • DELETE/doc-versions/{projectId}/{versionId}— Delete version and all its content (cannot delete ACTIVE version)
  • GET/documents/{documentId}/comments/{id}— Get a comment
  • PATCH/documents/{documentId}/comments/{id}— Update a comment
  • DELETE/documents/{documentId}/comments/{id}— Delete a comment
  • GET/github/repos/{owner}/{repo}/branches— List branches for a specific repository
  • GET/gitlab/repos/{owner}/{repo}/branches— List branches for a specific repository
  • GET/projects/{projectId}/change-requests— List change requests for a project (newest first)
  • POST/projects/{projectId}/change-requests— Open a change request (proposed content is staged on a cr/<id> branch by the worker)
  • POST/projects/{projectId}/git-sync/mirror— Queue an outbound mirror now (idempotent — deduped per project)
  • DELETE/public/p/{slugWithId}/reader/account— Delete the reader account (cascades profiles/keys, anonymizes call logs)
  • GET/public/p/{slugWithId}/recent-changes— Pages updated since a timestamp (reader "what changed since your last visit")
  • GET/public/p/{slugWithId}/sdk/{language}— Download an SDK — typescript streams, generated languages 302 to the zip
  • GET/public/p/{slugWithId}/support-agents— Get all enabled support agents for a project (public)
  • POST/technical-docs/{projectId}/rag/index— Embed the technical docs into the RAG vector store (runs on the worker)
  • POST/technical-docs/{projectId}/trueup-gc— True-up GC: hard-remove removed-badged pages past the grace period
  • GET/documents/{id}/revisions/{revisionId}— Get a specific revision
  • POST/knowledge-graph/document/{id}/extract— Extract entities from document
  • GET/knowledge-graph/entities/{id}/related— Find related entities
  • GET/manuals-insights/{projectId}/insights— Manual improvement guidance: weak pages, topic gaps, coverage gaps
  • GET/projects/{projectId}/boards/{boardId}— Get a board with columns and (optionally) cards
  • PATCH/projects/{projectId}/boards/{boardId}— Update board metadata
  • DELETE/projects/{projectId}/boards/{boardId}— Soft-delete a board (default board cannot be deleted)
  • GET/projects/{projectId}/issues/{issueId}— Get full issue detail
  • PATCH/projects/{projectId}/issues/{issueId}— Update issue (status, priority, assignee, close reason)
  • GET/public/p/{slugWithId}/access/branding— Ungated minimal branding for the gate screen (logo/name/colors only)
  • POST/public/p/{slugWithId}/access/password— Exchange the shared password for a reader token
  • POST/public/p/{slugWithId}/chat/resolution— Record whether the support chat resolved the question
  • GET/public/p/{slugWithId}/pages/{slug}.md— Raw markdown twin of a single published page
  • POST/public/p/{slugWithId}/reader/exchange— Exchange a customer-signed reader JWT for a segmented docs-reader token
  • GET/technical-docs/{projectId}/api-target— Get the Live API target config (docs-as-executable-MCP-tools); never returns the auth value
  • PUT/technical-docs/{projectId}/api-target— setApiTarget
  • GET/technical-docs/{projectId}/connectors— List managed ingestion connectors (config never returned)
  • POST/technical-docs/{projectId}/connectors— Create a managed connector (zendesk|intercom) — primes an initial sync
  • GET/technical-docs/{projectId}/escalation— Get the escalate-to-human webhook config — 3.1
  • PUT/technical-docs/{projectId}/escalation— Set the escalate-to-human webhook (Slack-compatible URL; empty clears) — 3.1
  • GET/analytics/{projectId}/feedback-summary— Get helpfulness feedback summary for a project
  • POST/analytics/{projectId}/reports/{id}/run— Manually run a scheduled report now (for testing)
  • GET/analytics/{projectId}/scroll-histogram— Get scroll-depth histogram (0-25%, 25-50%, 50-75%, 75-100%)
  • GET/api/orchestrator/knowledge-graph/stats— Get Knowledge Graph statistics
  • GET/manuals-insights/{projectId}/freshness— Public: is this manual page stale? (reader freshness badge)
  • GET/organizations/{id}/scim-group-mappings— List SCIM group → role/audience mappings
  • POST/organizations/{id}/scim-group-mappings— Create/replace a SCIM group mapping
  • POST/projects/{projectId}/documents/reindex— Reindex all documents for search
  • POST/public/p/{slugWithId}/playground/proxy— Server-side try-it proxy for the public playground (pinned to the project's declared API hosts)
  • POST/technical-docs/{projectId}/chat/stream— Ask within a session — grounded answer streamed as SSE
  • POST/technical-docs/{projectId}/sources/pdf— Upload a PDF as an external RAG source (multipart field "file")
  • POST/technical-docs/{projectId}/sources/url— Import a public web page (HTML/markdown) as an external RAG source
  • GET/bitbucket/repos/{owner}/{repo}/branches— listBranches
  • PATCH/categories/{categoryId}/documents/order— Reorder documents in a category
  • GET/changelog/{projectId}/entries/{entryId}— Get one entry including its raw change-set
  • PATCH/changelog/{projectId}/entries/{entryId}— Edit a draft (title/body/tags) — owner words beat the AI pass
  • POST/desk/{projectId}/threads/{id}/duplicate— Reversible merge: close this ticket as a duplicate of another (reopen reverses it)
  • GET/documents/{documentId}/suggestions/{id}— getById
  • DELETE/documents/{documentId}/suggestions/{id}— delete
  • GET/documents/{id}/versions/{versionNumber}— Get a specific named version
  • GET/manuals-insights/{projectId}/deflection— Deflection & CSAT cockpit: resolution vs deflection rate, AI CSAT, escalation, trend
  • POST/projects/{projectId}/relationships/sync— Sync batch of knowledge graph relationships from CLI
  • GET/public/p/{slugWithId}/changelog/confirm— Confirm a changelog subscription (emailed link)
  • GET/public/p/{slugWithId}/changelog/rss.xml— Changelog RSS 2.0 feed
  • GET/public/p/{slugWithId}/entity/{entityId}— Get a single entity with linked docs (public)
  • GET/public/p/{slugWithId}/playground-config— Public playground config: proxy availability + opt-in sandbox test key
  • POST/public/p/{slugWithId}/reader/auth/start— Send a one-time magic sign-in link for the docs developer hub
  • GET/public/p/{slugWithId}/search-index.json— Prebuilt static search index for offline/client-side search
  • POST/desk/{projectId}/threads/{id}/transition— Queue transition (accept/investigating/waiting/snooze/wake/done/reopen/decline)
  • POST/doc-automation/jobs/{id}/external-failed— Report a TERMINAL failure for an externally-driven job (atlorix-runner)
  • DELETE/organizations/{id}/scim-tokens/{tokenId}— Revoke a SCIM token
  • GET/projects/{projectId}/entities/{entityId}— Get a single entity by ID
  • POST/public/p/{slugWithId}/reader/auth/verify— Redeem a magic-link code for the docs-reader token (single-use)
  • GET/public/p/{slugWithId}/technical-snapshot— Get technical snapshot nav map for a published project
  • POST/technical-docs/{projectId}/chat/sessions— Create a grounded-chat session (conversation memory)
  • POST/technical-docs/{projectId}/export/notion— Export the published doc set into Notion as a page-tree (dryRun previews the block-tree, no token) — WS-E
  • GET/technical-docs/{projectId}/llms-full.txt— Full concatenated technical-docs corpus (single-ingest for AI agents)
  • POST/tours/{projectId}/experiences/{id}/pause— Pause (back to draft)
  • GET/doc-versions/{projectId}/compare/document— Get raw content for per-document diff
  • POST/public/p/{slugWithId}/access/email/verify— Verify the email code for a reader token
  • GET/public/p/{slugWithId}/changelog/feed.json— Changelog JSON Feed 1.1
  • POST/public/p/{slugWithId}/changelog/subscribe— Subscribe to release-note emails (double-opt-in; confirmation email sent)
  • POST/public/p/{slugWithId}/reader/auth/confirm— Redeem the magic-link code + 302 back to the docs site (token in fragment)
  • DELETE/public/p/{slugWithId}/reader/keys/{keyId}— Revoke a reader API key (scoped to the calling account)
  • GET/tours/{projectId}/experiences/{id}/funnel— Per-experience funnel (started → step drop-off → completed)
  • GET/analytics/{projectId}/zero-result-searches— Get top search queries that returned zero results (content gaps)
  • GET/doc-automation/config/{projectId}/triggers— Get webhook/schedule trigger configuration
  • PUT/doc-automation/config/{projectId}/triggers— Update webhook/schedule trigger configuration
  • POST/doc-automation/jobs/{id}/external-progress— Report progress for an externally-driven job (atlorix-runner)
  • GET/doc-versions/{projectId}/approvals/pending— List all pending approvals for a project
  • DELETE/documents/{documentId}/comments/{id}/admin— Admin delete a comment
  • GET/manuals-insights/{projectId}/ticket-topics— Ticket → content loop: recurring resolved-question clusters worth documenting
  • GET/public/p/{slugWithId}/reader/auth/callback— Magic-link landing: renders the confirm page (does NOT redeem)
  • GET/support-agent/{projectId}/agents/{agentId}— Get a specific agent
  • PUT/support-agent/{projectId}/agents/{agentId}— Update an agent
  • DELETE/support-agent/{projectId}/agents/{agentId}— Delete an agent
  • DELETE/technical-docs/{projectId}/connectors/{id}— Delete a connector (leaves already-ingested docs in place)
  • GET/technical-docs/{projectId}/pages/{slug}.md— Clean markdown twin of a technical-docs page (the .md URL)
  • POST/technical-docs/{projectId}/sources/zendesk— Import recently-solved Zendesk tickets into the RAG corpus (4.3)
  • POST/tours/{projectId}/experiences/{id}/archive— Archive (retire, keep analytics)
  • POST/tours/{projectId}/experiences/{id}/publish— Publish (go live)
  • GET/doc-versions/{projectId}/{versionId}/access— Get version access control settings
  • POST/doc-versions/{projectId}/{versionId}/access— Update version access control
  • GET/doc-versions/{projectId}/{versionId}/review— Get pre-publish review data for a version
  • GET/knowledge-graph/entities/{id}/relationships— Get all relationships for an entity
  • GET/projects/{projectId}/boards/{boardId}/cards— List cards on a board (use ?since= for incremental polling)
  • POST/projects/{projectId}/boards/{boardId}/cards— Add issues to a board (bulk)
  • GET/projects/{projectId}/change-requests/{crId}— Get one change request
  • GET/public/p/{slugWithId}/changelog/unsubscribe— Unsubscribe from changelog emails (emailed link)
  • POST/technical-docs/{projectId}/playground/proxy— Server-side try-it proxy — lets the playground call APIs that block CORS (Tier 3.4)
  • POST/technical-docs/{projectId}/sources/intercom— Import Intercom conversations into the RAG corpus (4.3)
  • POST/tours/{projectId}/experiences/{id}/validate— Validate the tour’s selectors against the live app now (self-healing)
  • GET/doc-automation/config/{projectId}/deliveries— Get recent webhook deliveries
  • POST/doc-versions/{projectId}/{versionId}/archive— Archive version (read-only)
  • POST/doc-versions/{projectId}/{versionId}/publish— Publish version (multi-version publishing)
  • POST/documents/{documentId}/comments/{id}/replies— Add a reply
  • POST/documents/{documentId}/comments/{id}/resolve— Resolve a comment
  • GET/projects/{projectId}/issues/{issueId}/boards— List boards an issue is currently on
  • GET/public/issues/{projectSlugId}/{ticketNumber}— Get public ticket tracking data (no auth — reporterSessionId proves ownership, same gate as reply)
  • GET/technical-docs/{projectId}/entity/{entityId}— Get a single entity with linked documents
  • POST/technical-docs/{projectId}/export/confluence— Export the published doc set into a Confluence space (create-or-update by title) — 3.3
  • GET/doc-automation/config/{projectId}/webhook-url— Get webhook URLs for CI/CD setup
  • GET/doc-automation/projects/{projectId}/scenarios— List scenario candidates for a project
  • POST/doc-automation/projects/{projectId}/scenarios— Add a custom scenario
  • POST/doc-versions/{projectId}/{versionId}/activate— Set version as active (primary)
  • GET/doc-versions/{projectId}/{versionId}/approval— Get approval status for a version
  • PATCH/doc-versions/{projectId}/{versionId}/schedule— Schedule a version to go live at a future time (UTC-compared; timezone is display-only)
  • DELETE/doc-versions/{projectId}/{versionId}/schedule— Cancel a pending scheduled activation
  • POST/documents/{id}/revisions/{revisionId}/restore— Restore document from revision
  • GET/organizations/{id}/members/{userId}/audiences— Get a user's audience memberships
  • PATCH/organizations/{id}/members/{userId}/audiences— Update a user's audience memberships
  • POST/projects/{projectId}/boards/{boardId}/columns— Add a column to a board
  • POST/projects/{projectId}/boards/{boardId}/restore— Restore a soft-deleted board (within the 30-day window)
  • GET/projects/{projectId}/snippets/{id}/references— List pages referencing this snippet
  • GET/public/p/{slugWithId}/preview/{crId}/manifest— Preview manifest for a change request (title, status, changed pages)
  • POST/capture/{projectId}/flows/{id}/reshoot-locales— Re-shoot the whole recipe under N locales (localized set)
  • GET/doc-versions/{projectId}/{versionId}/changelog— Get or generate changelog for a version
  • POST/doc-versions/{projectId}/{versionId}/deprecate— Deprecate version (shows banner)
  • POST/documents/{documentId}/comments/{id}/unresolve— Unresolve a comment
  • POST/documents/{documentId}/suggestions/{id}/accept— accept
  • POST/documents/{documentId}/suggestions/{id}/reject— reject
  • POST/projects/{projectId}/issues/{issueId}/comments— Add a comment to an issue
  • POST/technical-docs/{projectId}/pages/{slug}/assist— Grounded AI authoring: enhance/rewrite a doc page, grounded in the code
  • GET/technical-docs/{projectId}/playground/test-key— Get the stored sandbox test key + its public-visibility flag (members only)
  • PUT/technical-docs/{projectId}/playground/test-key— Set the sandbox token pre-filled in the API playground (Phase 2.4); empty clears
  • POST/changelog/{projectId}/entries/{entryId}/discard— Discard a draft
  • POST/changelog/{projectId}/entries/{entryId}/publish— Publish a draft (triggers subscriber email fan-out)
  • GET/doc-versions/{projectId}/{versionId}/export/pdf— Export version as a PDF
  • POST/documents/{id}/versions/{versionNumber}/restore— Restore document from named version
  • PUT/projects/{id}/documents/{docId}/visibility-rule— Set (or clear with null) a document visibility rule
  • POST/support-agent/{projectId}/agents/{agentId}/chat— Chat with a specific agent (version-aware, rate-limited)
  • POST/technical-docs/{projectId}/connectors/{id}/sync— Sync a connector now (pull the delta by cursor)
  • DELETE/technical-docs/{projectId}/sources/{documentId}— Remove an imported external source
  • POST/doc-automation/config/{projectId}/webhook-secret— Generate a new webhook secret
  • POST/doc-versions/{projectId}/{versionId}/cherry-pick— Cherry-pick a document from another version
  • GET/doc-versions/{projectId}/{versionId}/export/html— Export version as static HTML site
  • GET/doc-versions/{projectId}/{versionId}/screenshots— Get screenshot inventory for a version
  • POST/manuals-insights/{projectId}/ticket-topics/draft— Ticket → content loop: generate a grounded DRAFT from a topic cluster (no auto-publish)
  • GET/projects/{projectId}/issues/{issueId}/duplicates— Find potential duplicate issues
  • GET/doc-automation/config/{projectId}/screen-baseline— Get the screen baseline for change-aware regeneration (S3.1)
  • POST/projects/{projectId}/change-requests/{crId}/close— Close a change request without merging
  • POST/projects/{projectId}/change-requests/{crId}/merge— merge
  • POST/public/issues/{projectSlugId}/{ticketNumber}/csat— Ticket-level CSAT 1-5 (no auth, idempotent per ticket — second submit 409s)
  • PATCH/organizations/{id}/scim-group-mappings/{mappingId}— Update a SCIM group mapping
  • DELETE/organizations/{id}/scim-group-mappings/{mappingId}— Delete a SCIM group mapping
  • GET/public/documents/tree/{organizationId}/{projectId}— Get public document tree for navigation
  • POST/public/issues/{projectSlugId}/{ticketNumber}/reply— Customer reply on a tracked ticket (no auth — session id proves ownership). Reopens RESOLVED/CLOSED/PENDING/ON_HOLD tickets.
  • GET/support-agent/{projectId}/agents/{agentId}/history— Get chat history for an agent
  • DELETE/support-agent/{projectId}/agents/{agentId}/history— Clear chat history for an agent
  • PUT/technical-docs/{projectId}/connectors/{id}/enabled— Enable/disable a connector
  • POST/doc-versions/{projectId}/{versionId}/review/resolve— Resolve a single flagged document conflict
  • GET/l10n/documents/{documentId}/translations/{language}— Source + variant pair for the split-view translation editor
  • PUT/l10n/documents/{documentId}/translations/{language}— Save a translation variant (draft or published)
  • DELETE/l10n/documents/{documentId}/translations/{language}— Delete a translation variant
  • POST/projects/{projectId}/change-requests/{crId}/resolve— resolve
  • POST/doc-versions/{projectId}/{versionId}/approval/reject— Reject a version
  • GET/doc-versions/{projectId}/{versionId}/export/markdown— Export version as Markdown files
  • GET/l10n/projects/{projectId}/languages/{language}/pages— Per-page translation status for one target language
  • PATCH/projects/{projectId}/boards/{boardId}/cards/{cardId}— Move a card (column + position). Drives status if column maps to one.
  • DELETE/projects/{projectId}/boards/{boardId}/cards/{cardId}— Remove a card from a board (the underlying issue is preserved)
  • POST/technical-docs/{projectId}/pages/{slug}/assist/apply— Grounded AI authoring + persist: save the revised page as a DRAFT Document for review/publish
  • POST/doc-versions/{projectId}/{versionId}/approval/approve— Approve a version
  • POST/doc-versions/{projectId}/{versionId}/approval/request— Request approval for a version
  • POST/doc-versions/{projectId}/{versionId}/screenshots/bulk— Bulk screenshot action (remove/mark_not_needed)
  • PUT/projects/{id}/categories/{categoryId}/visibility-rule— Set (or clear with null) a category visibility rule (cascades to its docs)
  • PATCH/projects/{projectId}/boards/{boardId}/columns/reorder— Reorder columns on a board (full id list, in new order)
  • GET/projects/{projectId}/entities/{entityId}/relationships— Get relationships for a specific entity
  • POST/support-agent/{projectId}/agents/{agentId}/chat-stream— Stream chat responses from agent (SSE)
  • POST/doc-versions/{projectId}/{versionId}/review/resolve-all— Bulk resolve all flagged document conflicts
  • POST/doc-versions/{projectId}/{versionId}/screenshots/upload— Upload a manual screenshot for a route
  • POST/capture/{projectId}/flows/{id}/steps/{stepIndex}/reshoot— Re-shoot a single step (optionally at a new viewport/locale)
  • POST/doc-versions/{projectId}/{versionId}/screenshots/capture— Capture a screenshot for a route using Playwright
  • POST/doc-versions/{projectId}/{versionId}/screenshots/preview— Preview a screenshot — captures but does not save
  • PATCH/projects/{projectId}/boards/{boardId}/columns/{columnId}— Update a column
  • DELETE/projects/{projectId}/boards/{boardId}/columns/{columnId}— Delete a column (use ?moveCardsTo= to relocate its cards)
  • POST/projects/{projectId}/change-requests/{crId}/preview-link— previewLink
  • POST/projects/{projectId}/change-requests/{crId}/refresh-diff— Recompute diffCache + conflictState against current main (status unchanged; poll the row)
  • GET/public/p/{slugWithId}/audiences/{audienceSlug}/documents— Get documents for a specific audience
  • PUT/technical-docs/{projectId}/playground/test-key/visibility— Opt the sandbox test key in/out of the PUBLIC docs playground (visible to every visitor when on) — C1
  • POST/l10n/documents/{documentId}/translations/{language}/machine— Queue an AI translation for one page
  • POST/l10n/documents/{documentId}/translations/{language}/publish— Publish a translation variant
  • POST/l10n/documents/{documentId}/translations/{language}/unpublish— Unpublish a translation variant (back to draft)
  • POST/l10n/projects/{projectId}/languages/{language}/bulk-translate— Queue AI translation for a whole language (missing/stale/all pages)
  • POST/technical-docs/{projectId}/chat/messages/{messageId}/feedback— 👍/👎 an assistant answer (feeds the deflection dashboard)
  • POST/technical-docs/{projectId}/chat/sessions/{sessionId}/escalate— Escalate a chat session to a human (3.1 deflection loop)
  • GET/public/p/{slugWithId}/export/pdf/{audienceSlug}/{documentSlug}— Download one published page as a PDF (all plans, rendered on demand)
  • GET/public/p/{slugWithId}/audiences/{audienceSlug}/documents/{documentSlug}— Get a specific published document
  • PATCH/doc-versions/{projectId}/{versionId}/screenshots/{placeholderId}/annotations— Save authored annotations (arrow/box/mask/marker) for a screenshot
  • PATCH/doc-versions/{projectId}/{versionId}/screenshots/placeholders/{placeholderId}— Update a screenshot placeholder

openapi

  • GET/users— Get all users
  • POST/users— Create a new user
  • POST/auth/login— User login
  • GET/users/{id}— Get user by ID
  • PUT/users/{id}— Update user
  • DELETE/users/{id}— Delete user
ADocs generated by Atloria — from the code, always in sync →