Create a Voice Agent

post

https://api.liguelead.com.br/v1/voice-agent

Creates a voice agent for the authenticated client. If action_id is provided it must reference an existing voice action for the same client.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

required

length ≤ 100

Agent name (1–100 characters).

prompt

string

required

length ≤ 35000

Behavior instructions for the AI. Limit depends on engine.version: 2000 characters for lumen-mini, 25000 for lumen-1, 35000 for prisma-1.

greetings

string | null

Opening line spoken when the call connects. Optional — up to 600 characters when set. Sending null is treated as omitting the field.

engine

object

required

Engine that drives the call and the voice it speaks with. Required — there is no default engine. Each version accepts only its own voices: pick voice_id from the list GET /voice-agent/voices returns for the chosen version (422 otherwise).

voice_id

string

deprecated

Legacy alias of engine.voice_id, from the pre-engine contract. Considered only when engine.voice_id is omitted; sending both with different values returns 422. Prefer engine.voice_id.

stability

number | null

0 to 1

Defaults to 0.7

Voice tuning parameter: emotional consistency (0.0–1.0). Defaults to 0.7 when omitted, for engine.version lumen-mini/lumen-1. Forbidden for prisma-1 (422). Sending null is treated as omitting the field.

similarity_boost

number | null

0 to 1

Defaults to 0.75

Voice tuning parameter: fidelity to the original voice sample (0.0–1.0). Defaults to 0.75 when omitted, for engine.version lumen-mini/lumen-1. Forbidden for prisma-1 (422). Sending null is treated as omitting the field.

speed

number | null

0.7 to 1.2

Defaults to 1

Voice tuning parameter: speech speed (0.7–1.2, 1.0 = normal). Defaults to 1.0 when omitted, for engine.version lumen-mini/lumen-1. Forbidden for prisma-1 (422). Sending null is treated as omitting the field.

description

string | null

Optional free-text description (max 500 characters). Sending null is treated as omitting the field.

action_id

uuid | null

Optional ID of an existing voice action to attach. Not available when engine.version is lumen-mini — that engine ignores actions, so combining the two returns 422. Sending null is treated as omitting the field.

Responses

201Voice agent created

422Validation error (including a missing or incomplete engine object, an engine.voice_id not available for the chosen engine.version, engine.version: lumen-mini combined with action_id, or prisma-1 combined with any of stability/similarity_boost/speed) or unknown action_id.