Voice Agents
List scenario sets
Scenario sets are project-scoped and reusable across every voice agent in the project. The list omits each set's scenarios; fetch a set to get them.
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
Query Parameters
project_id*string
page?integer
Page number (1-based).
page_size?integer
Number of items per page. Values below the minimum or above the maximum are clamped to the nearest bound.
sort?string
Comma-separated sort fields. Prefix a field with - for descending order, e.g. sort=-started_at.
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/agents/voice/simulations/sets?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"{
"data": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"scenario_count": 0,
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"scenarios": [
{
"label": "string",
"instructions": "string",
"agent_expectations": "string",
"tags": {
"property1": "string",
"property2": "string"
},
"userdata": {}
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"pagination": {
"page": 0,
"page_size": 0,
"page_count": 0,
"total_count": 0
}
}{
"error": {
"code": "bad_request",
"message": "Bad Request",
"details": {
"input": "cannot be blank"
}
}
}{
"error": {
"code": "unauthorized",
"message": "Unauthorized"
}
}