Skip to content
DocuBot documentation

API reference

This reference describes the current status of programmatic access and the authentication mechanisms used to integrate your codebases with the documentation engine.

API availability

DocuBot is currently a dashboard-driven platform. A public REST API for external developers to programmatically manage projects or trigger documentation builds is not available in the current version of the repository.

All documentation management, including project creation, audience selection, and style configuration, occurs through the web interface. The system automates the documentation lifecycle by monitoring your connected GitHub repositories rather than requiring manual API calls.

Authentication and identity

The platform uses secure, industry-standard protocols to manage user identity and repository permissions.

User authentication

You access the dashboard using Google Sign-In. This manages your workspace identity and ensures that only authorized users can configure documentation projects or view private repository settings.

Repository authorization

To integrate with private repositories, the platform utilizes GitHub OAuth. This grant allows the documentation engine to:

  • Access source code for analysis.
  • Detect repository roles (such as Primary UI or API Reference).
  • Identify OpenAPI specifications.
  • Monitor for new commits to trigger synchronization jobs.

You can manage or revoke these permissions at any time through your GitHub account settings or the platform’s integration menu.

Repository integration flow

The primary method for aligning your codebase with the documentation engine is through the GitHub integration flow. While a direct API is not available, the integration functions as a programmatic bridge between your development environment and the published help center.

  1. Connection: You provide a GitHub repository URL as a source.
  2. Role detection: The engine scans the repository to determine its function. It identifies UI components, API definitions, and supporting reference material.
  3. Synchronization: The system tracks the default branch. When changes are detected, a sync job is queued to update the static documentation site automatically.

Support and API requests

If you have custom integration needs or wish to request early access to future programmatic interfaces, contact the support team.

When contacting support regarding integrations, include your workspace slug and the specific repository URLs you are attempting to document.