Voice Agents

List simulation runs

GET
/v1/agents/voice/agents/{agent_id}/simulations

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.

Query Parameters

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/agents/497f6eca-6276-4993-bfeb-53cbbbba6f08/simulations"
{
  "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"
    }
  ],
  "pagination": {
    "page": 0,
    "page_size": 0,
    "page_count": 0,
    "total_count": 0
  }
}
{
  "error": {
    "code": "unauthorized",
    "message": "Unauthorized"
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Not Found"
  }
}