Skip to main content

UnleashX API Documentation

Welcome to the UnleashX API! Our comprehensive API enables you to build sophisticated voice AI applications, manage conversational agents, and integrate human-like conversations into your workflows.

What is UnleashX?

UnleashX is a platform for building, deploying, and managing AI-powered voice agents and workflows. Our APIs provide everything you need to build intelligent voice applications at scale.

Key Features

  • Voice AI Agents: Create and manage agents for natural conversations
  • Phone & Chat Integration: Make/receive calls, build chatbots
  • API Control: Automate calls, control voice agents via API
  • Workflow Automation: Design complex workflow automations
  • Analytics & Reporting: Track usage and performance

Getting Started

To get started you need to log in to the UnleashX portal:
  • Visit the portal at https://www.tryunleashx.com/login and sign in with your account.
  • After signing in, open Profile & Settings → API Key and generate a persistent API token (this is the value you will pass in the token header).
For full authentication instructions and examples (token usage, generation, and verification), see the Authentication guide: /api-reference/authentication. Auth and user/workspace management sit under Auth & User, and are shared across every section below.

API Reference sections

Each area below has its own tab in the top navigation, with the full list of endpoints, requests, and responses.

Voice AI

Voice agents, Campaigns, Audience, Click to Call, and Activity Logs.

Evaluation

Evaluate voice agent and call quality.

Workflows

Orchestrate multi-step agent actions and automations.

Chatbots

Build and manage chat agents and conversations.

Apps & Data

Forms and Apps for collecting and connecting structured data.

Integrations

LLM, voice, and transcriber providers, plus MCP server integrations.

Base URL

All API requests should use:

API Design

  • RESTful Design: Consistent, resource-oriented URLs
  • JSON Format: Accepts and returns application/json
  • Standard HTTP: Uses HTTP verbs and status codes
  • Token Auth: API requests require a valid token header (your API token)

Example: Agent Creation (Authenticated)

Error Handling

The API uses standard HTTP status codes:
  • 200 - Success
  • 201 - Created
  • 400 - Bad Request
  • 401 - Unauthorized (invalid/expired token)
  • 404 - Not Found
  • 429 - Rate Limited
  • 500 - Server Error

Support

For help, contact: cs@unleashx.ai