API Overview

    The AIE REST API provides programmatic access to all platform features. Build custom integrations, automate workflows, and create powerful applications using our comprehensive API.

    RESTful Design

    Clean, predictable URLs and standard HTTP methods

    Secure

    API key authentication with rate limiting

    Fast & Reliable

    Global CDN with 99.9% uptime guarantee

    Base URL

    All API requests should be made to:

    https://api.aiechatbots.com/v1
    HTTPS Only
    Version 1
    Global CDN

    Authentication

    AIE uses API key authentication. Include your API key in the Authorization header of every request.

    Authentication Example
    // Authentication Header
Authorization: Bearer your-api-key-here

// Example cURL request
curl -X GET "https://api.aiechatbots.com/v1/chatbots" \
  -H "Authorization: Bearer your-api-key-here" \
  -H "Content-Type: application/json"

    Request Format

    All requests should be made with JSON content type and proper headers:

    Required Headers
    • Authorization: Bearer {api_key}
    • Content-Type: application/json
    • Accept: application/json
    Optional Headers
    • X-Request-ID: {unique_id}
    • User-Agent: {your_app}
    Request Body Example
    // POST request example
{
  "name": "Customer Support Bot",
  "description": "AI assistant for customer inquiries",
  "settings": {
    "language": "en",
    "tone": "friendly",
    "max_tokens": 150
  }
}

    Response Format

    All API responses follow a consistent JSON structure:

    Response Format
    // Successful response
{
  "success": true,
  "data": {
    "id": "chatbot_123456",
    "name": "Customer Support Bot",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z"
  },
  "meta": {
    "request_id": "req_789012",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

    Response Fields:

    • success: Boolean indicating if the request was successful
    • data: The requested data or result of the operation
    • meta: Additional information about the request and response

    Error Handling

    When errors occur, the API returns detailed error information:

    Error Response Format
    // Error response
{
  "success": false,
  "error": {
    "code": "INVALID_API_KEY",
    "message": "The provided API key is invalid or expired",
    "details": {
      "field": "authorization",
      "expected": "Bearer token format"
    }
  },
  "meta": {
    "request_id": "req_789013",
    "timestamp": "2024-01-15T10:30:00Z"
  }
}

    Common Error Codes:

    4xx Client Errors
    • 400: Bad Request - Invalid syntax
    • 401: Unauthorized - Invalid API key
    • 403: Forbidden - Access denied
    • 404: Not Found - Resource doesn't exist
    • 429: Too Many Requests - Rate limit exceeded
    5xx Server Errors
    • 500: Internal Server Error
    • 502: Bad Gateway
    • 503: Service Unavailable
    • 504: Gateway Timeout

    Rate Limits

    API requests are rate-limited to ensure fair usage and optimal performance:

    Free Plan
    1,000
    requests per hour
    Pro Plan
    10,000
    requests per hour
    Enterprise
    Custom
    based on your needs

    SDKs & Libraries

    Official SDKs and community libraries to simplify integration:

    JavaScript SDK
    For web applications
    Official SDK
    Python SDK
    For server applications
    Official SDK

    Available Endpoints

    Explore our comprehensive API endpoints organized by functionality:

    Chatbots
    Manage your AI chatbots
    GET
    /chatbots
    List all chatbots
    POST
    /chatbots
    Create a new chatbot
    GET
    /chatbots/{id}
    Get chatbot details
    PUT
    /chatbots/{id}
    Update chatbot
    DELETE
    /chatbots/{id}
    Delete chatbot
    Conversations
    Handle chat conversations
    GET
    /conversations
    List conversations
    POST
    /conversations
    Start a conversation
    POST
    /conversations/{id}/messages
    Send message
    GET
    /conversations/{id}
    Get conversation history
    Analytics
    Access performance data
    GET
    /analytics/overview
    Get overview metrics
    GET
    /analytics/conversations
    Conversation analytics
    GET
    /analytics/performance
    Performance metrics

    Ready to start building?

    Explore detailed endpoint documentation and try our interactive API explorer.

    View Full API Reference