Skip to main content
GET
/
simulations
/
{simulationId}
Get simulation
curl --request GET \
  --url https://app.freyavoice.ai/api/v2/simulations/{simulationId} \
  --header 'Authorization: Bearer <token>'
{
  "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>"
      },
      "personas": [
        {
          "id": "<string>",
          "workspaceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "prompt": "<string>",
          "successCriteria": "<string>",
          "tags": [
            "<string>"
          ],
          "agentIds": [
            "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          ],
          "createdAt": "<string>",
          "updatedAt": "<string>",
          "createdBy": "<string>",
          "updatedBy": "<string>",
          "versionNumber": 123
        }
      ],
      "assertions": [
        {
          "id": "<string>",
          "workspaceId": "<string>",
          "name": "<string>",
          "prompt": "<string>",
          "createdAt": "<string>",
          "updatedAt": "<string>"
        }
      ],
      "metrics": {
        "totalRuns": 0,
        "passedRuns": 0,
        "failedRuns": 0,
        "averageLatencyMs": null,
        "averageDurationSeconds": null,
        "agentSpeakingPercent": null
      },
      "publishedVersionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  }
}

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

Response

Simulation details

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