Getting Started

This guide walks you through generating an API key, making your first API call, understanding authentication, rate limits, and error handling.

Prerequisites

• A Conferbot account on the Starter plan or above. API access is not available on the Free plan. View plans
• At least one chatbot created in your workspace.

Step 1: Generate an API Key

1. Log in to your Conferbot dashboard.
2. Navigate to Workspace → API Keys tab.
3. Click "Generate API Key".
4. Copy the generated key immediately — it will be partially masked after creation.

Step 2: Authentication

All API requests must include your API key in the x-api-key header:

curl -X GET "https://api-v2.conferbot.com/api/v1/external/v1/chatbots" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json"

If the key is missing or invalid, the API returns 401 Unauthorized:

{
  "error": "Invalid or missing API key"
}

Step 3: Make Your First Request

Let's verify your setup by listing all chatbots in your workspace:

curl -X GET "https://api-v2.conferbot.com/api/v1/external/v1/chatbots" \
  -H "x-api-key: YOUR_API_KEY"

A successful response looks like:

{
  "data": [
    {
      "id": "64f8a2b3c1d4e5f6a7b8c9d0",
      "name": "Customer Support Bot",
      "status": "active",
      "responseCount": 12847,
      "createdAt": "2024-09-01T10:30:00.000Z",
      "updatedAt": "2024-12-15T14:22:00.000Z"
    }
  ]
}

Base URL

All API endpoints use the following base URL:

https://api-v2.conferbot.com/api/v1

External API endpoints are prefixed with /external/v1/. For example, the full URL for listing chatbots is:

https://api-v2.conferbot.com/api/v1/external/v1/chatbots

Rate Limits

The API enforces two types of rate limiting to ensure fair usage:

Per-minute rate limit

All endpoints are limited to 60 requests per minute per API key. Exceeding this returns 429 Too Many Requests.

Monthly usage limits

Monthly API call limits vary by plan:

Check your current usage anytime via the Usage endpoint.

curl -X GET "https://api-v2.conferbot.com/api/v1/external/v1/usage" \
  -H "x-api-key: YOUR_API_KEY"

{
  "data": {
    "month": "2025-01",
    "plan": "Starter",
    "used": 1423,
    "limit": 10000,
    "remaining": 8577
  }
}

Error Handling

The API uses standard HTTP status codes. Error responses include a descriptive error field:

Error response format

{
  "error": "Chatbot not found"
}

Next Steps