turbodog

Generate always-current API documentation from your code without sending source files to external servers.

Authentication

Base URL

https://maps.google.com/

Rate limits

Not specified.

Endpoints

Method	Path	Description
POST	/api/dev/link-installation	Links a GitHub installation to a customer by creating an installation record, a repository record, and a documentation site in the development environment.
POST	/api/dev/reset-repo	Clears all jobs associated with a given repository so the next pipeline run is treated as a first run.
GET	/api/auth/github	Initiates the GitHub OAuth authorization flow by redirecting the client to GitHub’s OAuth consent page.
GET	/api/auth/github/callback	Handles the GitHub OAuth callback by exchanging the authorization code for an access token, fetching the authenticated GitHub user’s identity, and redirecting to the onboarding page.
GET	/api/docsites	Returns all doc sites associated with the authenticated customer.
PATCH	/api/docsites/:docSiteId	Updates one or more properties of an existing doc site by its ID.
GET	/api/docsites/by-slug/:slug	Retrieves a doc site by its URL slug, with optional preview token support for non-public sites.
GET	/api/repos/:repoId/gaps	Retrieves the latest gap report for a specified repository.
POST	/api/repos/:repoId/gaps/config	Creates a pull request on GitHub with the provided YAML configuration content for a repository’s gaps config.
POST	/api/keys	Creates a new API key for a given customer and returns the raw key value.
GET	/api/keys	Retrieves all API keys associated with a specific customer.
DELETE	/api/keys/:keyId	Deletes (revokes) an API key by its ID, scoped to a specific customer.
POST	/api/publish	Publishes documentation for a repository and returns the published site URL and timestamp.
POST	/api/repos/connect	Connects a GitHub repository to the platform, creates a doc site, and queues an initial full-scan job.
GET	/api/jobs/:jobId/status	Retrieves the current status of a job by its ID.
GET	/api/repos	Retrieves a list of repositories associated with a specific customer.
GET	/api/github/installations/:installationId/repos	Retrieves the list of repositories accessible to a specific GitHub App installation.
GET	/api/repos/:repoId/runs	Retrieves all runs (jobs) associated with a specific repository.
GET	/api/runs/:runId	Retrieves a single run by its ID, including its events, current file snapshots, and the previous run’s snapshots for diff comparison.
POST	/api/runs/:runId/approve	Approves a run that is awaiting human review, transitioning it to processing status and optionally publishing it.
POST	/api/runs/:runId/restore	Restores a completed run by creating a new restore job that duplicates the original run’s snapshots and metadata.
POST	/api/runs/:runId/events	Appends a new event to an existing run identified by runId.
POST	/api/runs/:runId/snapshots	Creates a new file snapshot associated with a specific run, storing content such as LLM text, OpenAPI JSON, or documentation site files.
GET	/api/repos/:repoId/settings	Retrieves the settings for a specific repository by its ID.
PATCH	/api/repos/:repoId/settings	Updates one or more settings for a specific repository, such as branding, feature flags, and branch configuration.
GET	/api/repos/:repoId/overrides	Retrieves all file overrides for a specified repository.
PUT	/api/repos/:repoId/overrides/:fileType	Creates or replaces a file content override for a specific file type within a repository.
DELETE	/api/repos/:repoId/overrides/:fileType	Deletes a file type override for a specific repository.
POST	/api/onprem/publish	Publishes an on-premises API documentation package by accepting repository metadata and generated documentation artifacts, returning a hosted pages URL and a unique publish ID.
POST	/webhook/github	Receives and processes incoming GitHub webhook events.

Error format

Standard HTTP status codes with JSON error body.