Voice Agents
Start a simulation run
Runs a scenario set against the deployed agent. text mode exercises reasoning and tool use; audio mode also exercises speech recognition and synthesis and is the only mode that produces meaningful latency numbers.
Authorization
personalAccessToken AuthorizationBearer <token>
Personal Access Token of a Dynamiq user — the only credential accepted by the management API (api.*). Prefix dyn_pat_ (legacy uak_ tokens still authenticate). Send as Authorization: Bearer <token>.
In: header
Path Parameters
agent_id*string
Voice agent UUID.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/agents/voice/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/simulations" \ -H "Content-Type: application/json" \ -d '{ "simulation_set_id": "37abaeff-9946-45b0-8060-11df3359a2db" }'{
"data": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"set_name": "string",
"mode": "text",
"status": "pending",
"job_count": 0,
"passed_count": 0,
"failed_count": 0,
"scores": {
"accuracy_score": 0,
"experience_score": 0,
"scenario_pass_rate": 0
},
"error": "string",
"started_at": "2019-08-24T14:15:22Z",
"started_by": "03987f6a-4c27-4dc1-b6ab-c7e83bb3e713",
"ended_at": "2019-08-24T14:15:22Z"
}
}{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}