Skip to main content
PUT
/
simulations
/
{simulationId}
Update simulation
curl --request PUT \
  --url https://app2.freyavoice.ai/api/v2/simulations/{simulationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "status": "draft",
  "agentId": "<string>",
  "selectedPersonaIds": [
    "<string>"
  ],
  "assertions": [
    "<string>"
  ],
  "maxConcurrentCalls": 500,
  "maxCallDurationSeconds": 1830,
  "hangupOnTransfer": true,
  "metrics": {
    "totalRuns": 0,
    "passedRuns": 0,
    "failedRuns": 0,
    "averageLatencyMs": null,
    "averageDurationSeconds": null,
    "agentSpeakingPercent": null
  }
}
'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "simulation": {
        "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>"
      },
      "personas": [
        {
          "id": "<string>",
          "workspaceId": "<string>",
          "name": "<string>",
          "prompt": "<string>",
          "successCriteria": "<string>",
          "tags": [
            "<string>"
          ],
          "agentIds": [
            "<string>"
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "createdBy": "<string>",
          "updatedBy": "<string>"
        }
      ],
      "assertions": [
        {
          "id": "<string>",
          "name": "<string>",
          "prompt": "<string>",
          "points": 123,
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "metrics": {
        "totalRuns": 0,
        "passedRuns": 0,
        "failedRuns": 0,
        "averageLatencyMs": null,
        "averageDurationSeconds": null,
        "agentSpeakingPercent": null
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
simulationId
string<uuid>
required

Body

application/json
​
name
string
Minimum string length: 1
​
description
string | null
​
status
enum<string>
Available options:
draft,
running,
paused,
completed
​
agentId
string
​
selectedPersonaIds
string[]
​
assertions
string[]
​
maxConcurrentCalls
integer
Required range: 1 <= x <= 1000
​
maxCallDurationSeconds
integer
Required range: 60 <= x <= 3600
​
hangupOnTransfer
boolean
​
metrics
object

Response

Simulation updated

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