API Reference

Backend endpoints, MCP entrypoints, and the snapshot objects that power Documint on itself.

Core routes

• GET /health returns backend health plus cache and runtime details.
• GET /runtime returns deployment metadata, commit source, and whether git metadata is available.
• GET /snapshot returns the full project snapshot for the self-dogfood repo.
• GET /projects returns the configured project list. V1 exposes the dogfood project only.
• GET /sources returns the Git repository source configuration.
• GET /integrations/github/app returns GitHub App metadata, required events, and the install URL.
• POST /integrations/github/webhooks verifies GitHub deliveries and converts supported events into drift jobs.
• POST /jobs/drift runs the doc drift detector and returns a completed verification run.
• POST /jobs/publish creates a preview-style publish result for the current repo state.
• GET /artifacts/{artifact_id}/trace explains which source files and doc files back an artifact.

Snapshot objects

The public dashboard and the MCP surface share the same backend objects:

• Project
• RepositorySource
• RuntimeStatus
• ArtifactTrace
• DriftFinding
• DocPatch
• VerificationRun
• PublishDeployment

Auth

V1 allows read-only access without auth. Mutating routes can require a bearer token when AUTH_TOKEN or DOCUMINT_AUTH_TOKEN is configured.

GitHub webhooks are authenticated separately through X-Hub-Signature-256 using GITHUB_WEBHOOK_SECRET.

GitHub webhook behavior

• push deliveries collect changed files from the commit payload and run a scoped drift check.
• pull_request deliveries trigger a full artifact drift evaluation because the standard webhook payload does not include a file list.
• release deliveries trigger a full artifact drift evaluation before the next publish decision.
• unsupported events, mismatched repositories, and ignored actions are acknowledged with an ignored status instead of mutating state.

Dogfood rule

The API exists to prove the Documint repo can document itself first. External customer onboarding comes after the self-dogfood loop is stable.

Production note

When the backend runs in a container or managed deploy without a .git directory, Documint can still report the current revision if the platform provides DOCUMINT_DEPLOY_COMMIT, RAILWAY_GIT_COMMIT_SHA, VERCEL_GIT_COMMIT_SHA, or GITHUB_SHA.