Voice Agents
Generate scenarios
Drafts scenarios from the agent's own configuration. The scenarios are returned, not saved — review them and store them in a scenario set.
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/generate-scenarios" \ -H "Content-Type: application/json" \ -d '{}'{
"data": {
"scenarios": [
{
"label": "string",
"instructions": "string",
"agent_expectations": "string",
"tags": {
"property1": "string",
"property2": "string"
},
"userdata": {}
}
]
}
}{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}{
"error": {
"code": "not_found",
"message": "Not Found"
}
}