Status codes
Overview of status codes
DocuBot uses standard HTTP response codes to indicate the success or failure of your requests. Whether you are managing your workspace in the dashboard or accessing your published documentation, these codes provide immediate feedback on the result of your actions.
Success codes (2xx)
Success codes indicate that your request was received, understood, and accepted by the system.
- 200 OK: The request succeeded. This is the standard response for successful data retrieval, such as loading your repository list or viewing a documentation page.
- 201 Created: The request succeeded and resulted in the creation of a new resource. You see this after successfully initializing a new documentation site.
Client error codes (4xx)
Client error codes indicate that there was an issue with the request, often due to incorrect configuration or authentication failures.
- 400 Bad Request: The system cannot process the request due to invalid input. This typically happens if you provide an invalid URL slug or an incorrect configuration payload during setup.
- 401 Unauthorized: Authentication is required and has failed or was not provided. This occurs if your Google or GitHub session tokens are missing or have expired.
- 403 Forbidden: You do not have permission to access the resource. This most commonly happens when you try to sync a private repository without granting the necessary GitHub OAuth permissions.
- 404 Not Found: The requested resource could not be found. You may see this if you navigate to an invalid documentation route or if a repository source is missing.
Server error codes (5xx)
Server error codes indicate that the system encountered an unexpected condition while processing your request.
- 500 Internal Server Error: A generic error message indicating an unexpected failure during the documentation generation or synchronization process.
- 503 Service Unavailable: The system is temporarily unable to handle the request. This usually occurs during brief maintenance windows or when the generation engine is experiencing high traffic.
Common causes and resolutions
Use the following table to diagnose and fix the most frequent error states.
| Status Code | Common Cause | Resolution |
|---|---|---|
| 400 | Invalid or duplicate URL slug | Ensure your slug uses only lowercase letters, numbers, and dashes, and is unique across DocuBot. |
| 401 / 403 | Expired GitHub connection | Navigate to your account settings and re-authenticate your GitHub account to refresh access. |
| 404 | Incorrect repository URL | Verify that the GitHub repository URL is correct and that the repository has not been deleted or renamed. |
| 5xx | Generation engine timeout | Wait a few minutes and trigger a manual sync. If the error persists, check your repository for large files that might exceed processing limits. |
If you continue to experience issues with specific status codes, contact support at support@ademero.com, visit https://www.ademero.com, or call 863-937-0272.