Chanl Platform API

The Chanl API is the programmatic surface for building agent capabilities (tools, knowledge, memory, prompts), running test scenarios, and monitoring production conversations across voice, chat, and messaging channels.

Base URL

• Production: https://platform.chanl.ai (also https://api.chanl.ai)

All routes are under /api/v1/.

Key features

• Workspace-scoped — API keys infer workspace; no workspaceId in most SDK methods
• Multi-channel interactions — voice, chat, and messaging under /api/v1/interactions
• Agent backend — tools, toolsets, knowledge, memory, prompts, MCP
• Quality loop — scenarios, personas, scorecards, analytics

API overview

Authentication

API keys (recommended for SDK/CLI)

{
  "headers": {
    "X-API-Key": "<api_key>"
  }
}

JWT bearer tokens

{
  "headers": {
    "Authorization": "Bearer <jwt_token>"
  }
}

Rate limiting

API requests are rate-limited per workspace. Responses include:

• X-RateLimit-Limit
• X-RateLimit-Remaining
• X-RateLimit-Reset

Error handling

The API uses standard HTTP status codes and returns detailed error information:

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters",
    "details": {
      "field": "email",
      "issue": "Invalid email format"
    }
  }
}

OpenAPI specification