Dynamiq
PlatformPython SDKAPI Reference
Voice Agents

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.

POST
/v1/agents/voice/agents/{agent_id}/calls/{call_id}/scenario

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.

call_id*string

Voice call UUID.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agents/voice/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/calls/497f6eca-6276-4993-bfeb-53cbbbba6f08/scenario"
{
  "data": {
    "label": "string",
    "instructions": "string",
    "agent_expectations": "string",
    "tags": {
      "property1": "string",
      "property2": "string"
    },
    "userdata": {}
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Get a call recording URL

Returns a short-lived signed URL for the call's audio. Available only when recording was enabled for the call and the recording has finished processing (`recording_status` is `available`).

Check simulation availability

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