For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Status
OverviewProductsManageAPI ReferenceTutorialsClient Libraries
OverviewProductsManageAPI ReferenceTutorialsClient Libraries
  • Voice Generation
    • Speech-to-Speech
  • Voice Creation
  • Voice Tools
  • Real-Time Agents
    • Overview
      • List Agents
      • Get Agent
      • Create Agent
      • Update Agent
      • Delete Agent
      • Dispatch Agent
      • Get Capabilities
      • Get System Tools
  • Safety & Detection
Status
LogoLogo
On this page
  • HTTP Request
  • URL Parameters
  • Example Request
  • Response (Success)
  • Response (Error)
  • Response Body
  • Validation Rules
  • Common Error Scenarios
  • Missing ASR Configuration
  • Missing Voice
  • Orchestrator Connection Error
Real-Time AgentsAgents API

Dispatch Agent

Was this page helpful?
Previous

Get Capabilities

Next
Built with

Dispatch an agent to start handling conversations. This creates a conversation session and connects the agent to the orchestrator.

HTTP Request

$POST https://app.resemble.ai/api/v2/agents/{uuid}/dispatch

URL Parameters

ParameterTypeDescription
uuidstringThe unique identifier of the agent

Example Request

$curl --request POST "https://app.resemble.ai/api/v2/agents/550e8400-e29b-41d4-a716-446655440000/dispatch" \
> -H "Authorization: Bearer YOUR_API_TOKEN" \
> -H "Content-Type: application/json"

Response (Success)

1{
2 "success": true,
3 "item": {
4 "success": true,
5 "agent_id": 123,
6 "conversation_uuid": "conv-550e8400-e29b-41d4-a716-446655440000",
7 "session_id": "sess-abc123def456",
8 "status": "dispatched",
9 "message": "Agent dispatched successfully"
10 },
11 "message": "Agent dispatched successfully"
12}

Response (Error)

1{
2 "success": false,
3 "errors": {
4 "agent": ["Agent ASR configuration is missing"],
5 "dispatch": ["Failed to dispatch agent: Connection timeout"]
6 },
7 "message": "Failed to dispatch agent"
8}

Response Body

AttributeTypeDescription
successbooleanIndicates if the request was successful
item.agent_idintegerThe agent’s database ID
item.conversation_uuidstringUnique identifier for the conversation session
item.session_idstringSession identifier for the orchestrator
item.statusstringDispatch status
messagestringHuman-readable message

Validation Rules

Before dispatch, the agent must have all required configurations:

  • ASR configuration: Provider and model must be set
  • TTS configuration: Voice must be linked
  • Turn configuration: Turn-taking settings must be configured
  • LLM configuration: LLM provider and model must be set

If any required configuration is missing, the dispatch will fail with a detailed error message indicating which component is incomplete.

Common Error Scenarios

Missing ASR Configuration

1{
2 "success": false,
3 "errors": {
4 "agent": ["Agent ASR configuration is missing"]
5 },
6 "message": "Failed to dispatch agent"
7}

Missing Voice

1{
2 "success": false,
3 "errors": {
4 "agent": ["Agent TTS configuration is missing"]
5 },
6 "message": "Failed to dispatch agent"
7}

Orchestrator Connection Error

1{
2 "success": false,
3 "errors": {
4 "dispatch": ["Failed to dispatch agent: Connection timeout"]
5 },
6 "message": "Failed to dispatch agent"
7}