Dynamiq
PlatformPython SDKAPI Reference
Voice Agents

Cancel a simulation run

POST
/v1/agents/voice/agents/{agent_id}/simulations/{run_id}/cancel

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.

run_id*string

Simulation run UUID.

Response Body

application/json

application/json

application/json

curl -X POST "https://example.com/v1/agents/voice/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/simulations/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel"
{
  "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": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}

Get a simulation run

The run with its per-scenario results — verdict, rationale, scores, latency, and the full conversation.

Check requirements status for an end user

Returns whether all end-user requirements of the app are satisfied for the given user, together with the list of unsatisfied requirements. A connection requirement counts as satisfied when the user has an active connection for it; an action connector account requirement counts as satisfied when the user has linked an account for it. The app is identified by the hostname. Private apps require an Access Key; public apps can be called without credentials.