Skip to content
DocuBot documentation

API quick start

This guide helps you authenticate your environment and make your first request to the DocuBot API. By the end of this tutorial, you’ll have a valid connection to the service and understand how to interact with our endpoints.

Prerequisites

Before you begin, ensure you have the following:

  • A DocuBot account with the Developer audience role assigned.
  • Access to the DocuBot dashboard.
  • A tool to make HTTP requests, such as curl, Postman, or your preferred programming language.

1. Obtain your API credentials

You must have a valid API token to authorize your requests.

  1. Sign in to your DocuBot dashboard.
  2. Navigate to the Settings section.
  3. Locate the API key management area and generate a new token.
  4. Copy the token and store it securely.

Notice that for security reasons, the full token is only displayed once. If you lose it, you’ll need to generate a new one.

2. Configure authentication

DocuBot uses Bearer token authentication for all API interactions. You must include this token in the header of every request you send.

Set up your request headers using the following format:

Authorization: Bearer <YOUR_TOKEN>
Content-Type: application/json

Replace <YOUR_TOKEN> with the string you copied from your dashboard. Keep this token secure and never expose it in client-side code or public repositories.

3. Make your first request

Execute a simple GET request to verify your connectivity. While specific public API entrypoints are managed within your project settings, you can test your connection against your base project URL.

If you are using curl, run the following command in your terminal:

Terminal window
curl -X GET https://docubot.cc/api/v1/status \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Content-Type: application/json"

Note: If a public API is not yet documented for your specific repository, please contact our support team at support@ademero.com for assistance with your integration.

4. Verify the response

Confirm that the system recognized your request and returned valid data. A successful request returns a 200 OK status code.

Check the response body for a JSON object. It typically looks like this:

{
  "status": "success",
  "version": "1.0.0",
  "message": "Connection verified"
}

If you encounter a 401 Unauthorized or 404 Not Found error, double-check your Bearer token and ensure your account has the correct permissions.

Next steps

Now that you’ve successfully authenticated, you can explore the full capabilities of the DocuBot API:

  • Interactive API Reference: Access the full list of available endpoints via the API Reference link in your documentation sidebar.
  • Try it feature: Use the interactive Scalar UI to test requests in real-time directly from your browser.
  • Support: If you need technical help, visit https://www.ademero.com or call us at 863-937-0272.