Dynamiq
PlatformPython SDKAPI Reference
Voice Agents

Check simulation availability

Reports whether simulated test calls are available for this workspace. Existing results stay readable even when new runs are not available.

GET
/v1/agents/voice/simulations/status

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

Response Body

application/json

application/json

curl -X GET "https://example.com/v1/agents/voice/simulations/status?project_id=497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "data": {
    "available": true
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}

Draft a simulation scenario from a call

Derives a simulation scenario from a real conversation — the caller's persona and the expected outcome — so a call that went wrong becomes a regression test. The scenario is returned, not saved; add it to a scenario set to keep it.

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.