Skip to main content
POST
/
simulations
Create simulation
curl --request POST \
  --url https://app.freyavoice.ai/api/v2/simulations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "selectedPersonaIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "description": "<string>",
  "mode": "voice",
  "assertions": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "maxConcurrentCalls": 500,
  "maxCallDurationSeconds": 1830,
  "maxRetries": 5,
  "runsPerPersona": 25,
  "personaSystemPrompt": "<string>",
  "agentVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "success": true,
  "data": {
    "message": "<string>",
    "result": {
      "simulation": {
        "id": "<string>",
        "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "draft",
        "settings": {
          "maxConcurrentCalls": 1,
          "maxCallDurationSeconds": 60,
          "maxRetries": 3,
          "runsPerPersona": 1
        },
        "createdAt": "<string>",
        "updatedAt": "<string>",
        "description": "<string>",
        "metrics": {
          "totalRuns": 0,
          "passedRuns": 0,
          "failedRuns": 0,
          "averageLatencyMs": null,
          "averageDurationSeconds": null,
          "agentSpeakingPercent": null
        },
        "latestPassRate": 0.5,
        "createdBy": "<string>",
        "updatedBy": "<string>"
      }
    }
  }
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
workspaceId
string<uuid>
required
​
name
string
required
Minimum string length: 1
​
agentId
string<uuid>
required
​
selectedPersonaIds
string<uuid>[]
required
Required array length: 1 - 200 elements
​
description
string
​
mode
enum<string>
default:voice
Available options:
voice,
chat
​
assertions
string<uuid>[]
​
maxConcurrentCalls
integer
Required range: 1 <= x <= 1000
​
maxCallDurationSeconds
integer
Required range: 60 <= x <= 3600
​
maxRetries
integer
Required range: 0 <= x <= 10
​
runsPerPersona
integer
Required range: 1 <= x <= 50
​
assistantLlmOverride
object
​
personaLlmOverride
object
​
analysisLlmOverride
object
​
personaSystemPrompt
string
Maximum string length: 50000
​
agentVersionId
string<uuid>

Response

Simulation created

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