Welcome to Bots.Business Api Socumentation.

There is a known inconsistency in our V2 API regarding response structures, which can vary between endpoints. We are currently building version 3 to resolve this. Please use the following error examples as a guide to avoid confusion.

401 Unauthorized

You will receive this error when the provided API key is invalid.

Example Response:

{"errors": ["You need to sign in or sign up before continuing."]}

404 Not Found

This error occurs when you call an endpoint to manage a specific resource (like a Bot, Command, or Folder) but the provided ID does not exist.

Example Response:

{"error": "Bot not found"}

Important Notes on V2 API Behavior

Creation Endpoints: When sending a request to create a bot or command, the resource may be created with null values if data is missing. Please validate these values in your application wrapper or front-end until the new API version is released.

Empty Results: The "Get Bots," "Get Commands," or "Get Folders" endpoints may return an empty array [] when no resources are found.

Plain Text Responses: Some endpoints (like Git import/export) may return responses in plain text, such as: true, ok, or success.

Success Messages: A 200 OK response may sometimes contain only a message field to confirm the request was successful.

Example:

{"message": "Operation successful"}

API Conventions & Additional Details

Authentication

Use this endpoint to get user details including api_key which can be used to send requests to other endpoints.
You will have to put the Access-Token, Client and Uuid on headers of the request or you can simply use api_key for more sufficiency.

The API supports two authentication methods:

Using an API Key: You can interact with any API endpoint by including your api_key as a query parameter in the endpoint URL.

Using Headers: Alternatively, you can add the following headers to your request:

Access-Token

Client

Uid

Important Note: The values provided for the headers are for single-use only. You will receive new values for them in the headers of each API response.

Recommendation: After a successful login or registration, call the "Get User Details" API endpoint using the initial headers to retrieve your permanent API key. You should then use this api_key for all future requests, as it provides a more straightforward authentication method. We will not repeat telling you this on every page, we will be using api_key at params, you will chose what best for you.

Timestamps

All timestamps returned by the API (e.g., created_at, updated_at) follow the ISO 801 standard and are in UTC.

Example Timestamp: 2025-10-29T14:30:00Z

Bot Status Values

When managing bot status, you will use specific string values to initiate actions:

To Start a Bot: Set the status value to start_launch.

To Stop a Bot: Set the status value to start_stopping.

Get started

Welcome to Bots.Business Api Socumentation.#

401 Unauthorized#

404 Not Found#

Important Notes on V2 API Behavior#

API Conventions & Additional Details#

Authentication#

Timestamps#

Bot Status Values#