Skip to main content

​
Getting Started

The Kaie API is a RESTful API that allows you to programmatically interact with your workflows, analytics, and platform features. You can use it to create, manage, and monitor workflows, access analytics data, and integrate with external systems.

​
Authentication

All API requests require authentication. You can authenticate using an API key in the Authorization header: 
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.kaie.ai/v1/workflows

​
Base URL

All API requests are made to the base URL: 
https://api.kaie.ai/v1

​
Rate Limits

API requests are rate limited to 1000 requests per hour per API key. If you exceed this limit, you’ll receive a 429 Too Many Requests response.

​
Response Format

All API responses are returned in JSON format. Successful responses include a data field containing the requested information: 
{
  "data": {
    "id": "workflow-123",
    "name": "Customer Support Bot",
    "status": "active",
    "created_at": "2024-01-15T10:30:00Z"
  }
}
Error responses include an error field with details about what went wrong: 
{
  "error": {
    "code": "INVALID_REQUEST",
    "message": "The request was invalid",
    "details": "Workflow name is required"
  }
}

​
Pagination

List endpoints support pagination using query parameters:
  • page: Page number (default: 1)
  • limit: Number of items per page (default: 20, max: 100)
curl "https://api.kaie.ai/v1/workflows?page=2&limit=50"

​
Error Handling

The API uses standard HTTP status codes to indicate success or failure:
  • 200 OK: Request successful
  • 201 Created: Resource created successfully
  • 400 Bad Request: Invalid request
  • 401 Unauthorized: Authentication required
  • 403 Forbidden: Access denied
  • 404 Not Found: Resource not found
  • 429 Too Many Requests: Rate limit exceeded
  • 500 Internal Server Error: Server error

​
SDKs

We provide official SDKs for popular programming languages:

​
Support

If you have questions or need help, please:
  1. Check our documentation
  2. Join our community
  3. Contact support