Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-26104203277.0 KB

Create Voice Agent

Creates a new voice agent using the V2 API with enhanced configuration options.

post/v2/voice-agents

Request body

type'Single Prompt' | 'Flow Agent'

Type of voice agent.

namestring required

Name of the voice agent (max 150 characters).

knowledgeBaseItemsIdsstring[]

Array of knowledge base item UUIDs.

voiceDictionaryIdsstring[]

Array of voice dictionary UUIDs.

webhookUrlstring uri

Webhook URL for external integrations.

webhookAuthobject

Webhook authentication configuration.

outcomeResponseShapeobject

Expected outcome response structure.

Example request

{
  "type": "Single Prompt",
  "name": "Customer Support Agent",
  "conversation": {
    "greetingMessage": "Welcome! How may I assist you?",
    "greetingMessageType": "TEXT",
    "preamble": "You are a customer support assistant.",
    "pokeMessages": [
      "Are you still there?"
    ],
    "params": {},
    "alignment": {
      "greetingMessage": "ltr",
      "preamble": "ltr"
    }
  },
  "voice": {
    "voiceId": "en-US-Neural2-A",
    "lang": "en"
  },
  "llm": {
    "provider": "openai",
    "model": "gpt-4",
    "temperature": 0.7,
    "baseUrl": "https://api.example.com",
    "apiKey": "sk-..."
  },
  "callSettings": {
    "noiseCancellation": "telephony_optimized",
    "cancelNoisePer": "conversation",
    "interrupt": true,
    "responseDelay": 400,
    "minInterruptionDuration": 0.5,
    "vadActivationThreshold": 0.5,
    "userInactivityTimeout": 15,
    "maxCallDuration": 300,
    "silenceThreshold": 800
  },
  "tools": [
    {
      "persistentId": "tool_123",
      "toolId": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
      "version": 1,
      "toolType": "FUNCTION",
      "nodeId": "node_1"
    }
  ],
  "knowledgeBaseItemsIds": [
    "48f7656f-098b-4c43-b165-7cfd2cc8ac30"
  ],
  "voiceDictionaryIds": [
    "48f7656f-098b-4c43-b165-7cfd2cc8ac30"
  ],
  "phoneNumber": {
    "type": "TWILIO",
    "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30"
  },
  "webhookUrl": "https://example.com/webhook",
  "workflow": {
    "nodes": [
      {
        "id": "2ZHj3IUpJFc-83H2-f8d3",
        "type": "start",
        "label": "Start",
        "message": "Hello, how can I help you today?",
        "messageType": "prompt",
        "position": {
          "x": 0,
          "y": 0
        },
        "metadata": {
          "version": 1
        },
        "transitions": []
      }
    ],
    "edges": [],
    "customVariables": [
      {
        "id": "z5QsyxUbrKPjYMGaMj1e1",
        "name": "customer_name",
        "dataType": "string",
        "description": "",
        "defaultValue": "john",
        "extractionPrompt": "",
        "enumValues": []
      }
    ]
  }
}

Response

Successful response

successboolean
messagestring
messageKeystring

Example response

{
  "success": true,
  "message": "Voice agent created successfully",
  "messageKey": "VoiceAgentCreatedSuccessfully",
  "data": {
    "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30",
    "type": "Single Prompt",
    "name": "Customer Support Agent",
    "conversation": {
      "greetingMessage": "Hello, how can I help you today?",
      "preamble": "You are a helpful assistant.",
      "pokeMessages": [],
      "params": {},
      "alignment": {
        "greetingMessage": "ltr",
        "preamble": "ltr"
      }
    },
    "voice": {
      "voiceId": "en-US-Neural2-A",
      "lang": "en"
    },
    "llm": {
      "provider": "openai",
      "model": "gpt-4",
      "temperature": 0.2
    },
    "callSettings": {
      "noiseCancellation": "telephony_optimized",
      "cancelNoisePer": "conversation",
      "interrupt": true,
      "responseDelay": 400,
      "userInactivityTimeout": 15,
      "maxCallDuration": 300,
      "silenceThreshold": 800,
      "minInterruptionDuration": 0.5,
      "vadActivationThreshold": 0.5
    },
    "knowledgeBaseItemsIds": [],
    "voiceDictionaryIds": [],
    "phoneNumber": {
      "type": "TWILIO",
      "id": "48f7656f-098b-4c43-b165-7cfd2cc8ac30"
    },
    "workflow": {
      "nodes": [
        {
          "id": "2ZHj3IUpJFc-83H2-f8d3",
          "type": "start",
          "label": "Start",
          "message": "Hello, how can I help you today?",
          "messageType": "prompt",
          "position": {
            "x": 0,
            "y": 0
          },
          "metadata": {
            "version": 1
          },
          "transitions": []
        }
      ],
      "edges": [],
      "customVariables": [
        {
          "id": "z5QsyxUbrKPjYMGaMj1e1",
          "name": "customer_name",
          "dataType": "string",
          "description": "",
          "defaultValue": "john",
          "extractionPrompt": "",
          "enumValues": []
        }
      ]
    },
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "account": {
      "plan": "pro"
    }
  }
}