API reference
The DocuBot API allows you to programmatically manage your documentation sites, configure repository sources, and trigger synchronization jobs. All API requests require authentication and return data in JSON format.
Authentication
You must authenticate every request to the DocuBot API using a Bearer token. This token is associated with your Google Sign-In credentials.
Include the token in the Authorization header of your HTTP requests:
Authorization: Bearer <YOUR_TOKEN>
Create repository
Register a new product documentation site and connect its source repositories.
- Endpoint:
POST /api/repos - Format:
application/json
Request body
| Field | Type | Description |
|---|---|---|
displayName | string | The internal name for the repository workspace. |
slug | string | The unique URL path for your documentation (e.g., my-product). |
sources | array | A list of objects containing repoUrl (GitHub URL) and optional label. |
syncFrequency | string | How often to update: daily, weekly, or monthly. |
generalStyleKey | string | The visual and tonal style, such as docubot-default. |
audiences | array | Target groups like End User, Admin, or Developer. |
docTypes | array | Specific document keys to generate. |
Update repository
Modify the configuration, audiences, or focus areas for an existing documentation site.
- Endpoint:
PATCH /api/repos/{repoId} - Format:
application/json
Request body
| Field | Type | Description |
|---|---|---|
displayName | string | Updated name for the workspace. |
audiences | array | Updated list of target audiences. |
docTypes | array | Updated list of document types to include. |
scenarioFocus | array | A list of specific user workflows to prioritize in guides. |
knownIssues | array | A list of issues to include in workaround articles. |
Trigger manual sync
Request an immediate documentation rebuild outside of your automated schedule.
- Endpoint:
POST /api/repos/{repoId}/sync - Format:
application/json
Request body
| Field | Type | Description |
|---|---|---|
rebuildOnly | boolean | If true, regenerates site files without pulling new code changes. |
Note: Manual syncs are subject to daily limits based on your account tier.
GitHub connection
Initiate the OAuth flow to grant DocuBot access to your private repositories.
- Endpoint:
POST /api/github/connect
Response
The API returns an authorizeUrl. You must redirect your browser to this URL to complete the GitHub authorization process.
Invite request
Request access to the DocuBot platform if your account is not yet authorized.
- Endpoint:
POST /api/invite-request
This endpoint records your request for review by the DocuBot administration team.
Account management
Permanently remove your account and all associated documentation data.
- Endpoint:
POST /api/account/delete - Format:
application/json
Request body
| Field | Type | Description |
|---|---|---|
confirm | string | You must provide the exact phrase: delete my account. |
Warning: This action is irreversible and deletes all tracked repositories and generated documentation.
Support
If you encounter issues with the API or need assistance with integration, contact our support team:
- Email: support@ademero.com
- Web: https://www.ademero.com
- Phone: 863-937-0272