Skip to main content
GET
/
simulations
List simulations
curl --request GET \
  --url https://app2.freyavoice.ai/api/v2/simulations \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "simulations": [
        {
          "id": "<string>",
          "workspaceId": "<string>",
          "agentId": "<string>",
          "name": "<string>",
          "status": "draft",
          "settings": {
            "maxConcurrentCalls": 10,
            "maxCallDurationSeconds": 600,
            "hangupOnTransfer": false
          },
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "description": "<string>",
          "metrics": {
            "totalRuns": 0,
            "passedRuns": 0,
            "failedRuns": 0,
            "averageLatencyMs": null,
            "averageDurationSeconds": null,
            "agentSpeakingPercent": null
          },
          "createdBy": "<string>",
          "updatedBy": "<string>"
        }
      ]
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

workspaceId
string
required
Minimum string length: 1
status
enum<string>
Available options:
draft,
running,
paused,
completed
filters
string
sortBy
string
sortOrder
enum<string>
Available options:
asc,
desc
limit
integer
offset
integer
Required range: x >= 0

Response

Simulations list

success
enum<boolean>
required
Available options:
true,
false
data
object
required