Simulation Job

Get simulation by ID

Get a individual simulation run directly by its ID. This is generally part of a larger simulation run plan job.

get/v1/simulation/job/{jobId}

Path parameters

jobIdstring uuid required

Simulation job ID

Response

Successfully found simulation job

Example response

{
  "data": {
    "simulationJobId": "7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
    "status": "COMPLETED",
    "processingStatus": "PROCESSED",
    "callId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "roarkPhoneNumber": "+15551234567",
    "runPlan": {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "name": "Billing Flow Test",
      "variables": {
        "promptToUse": "v1",
        "accountTier": "premium"
      }
    },
    "persona": {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "name": "Sarah Johnson - Anxious Patient",
      "language": "EN",
      "secondaryLanguage": null,
      "understoodLanguages": [
        "EN"
      ],
      "accent": "US",
      "age": "ADULT",
      "gender": "FEMALE",
      "backgroundNoise": "OFFICE",
      "speechPace": "NORMAL",
      "speechClarity": "CLEAR",
      "hasDisfluencies": false,
      "baseEmotion": "FRUSTRATED",
      "intentClarity": "CLEAR",
      "confirmationStyle": "EXPLICIT",
      "memoryReliability": "HIGH",
      "responseTiming": "NORMAL",
      "backstoryPrompt": "A busy professional calling during lunch break",
      "idleMessages": null,
      "idleTimeoutSeconds": 10,
      "idleMessageMaxSpokenCount": 3,
      "idleMessageResetCountOnUserSpeechEnabled": true,
      "properties": {
        "age": "35",
        "zipCode": "94105"
      },
      "createdAt": "2025-01-10T12:00:00.000Z",
      "updatedAt": "2025-01-10T12:00:00.000Z"
    },
    "scenario": {
      "id": "f8e7d6c5-b4a3-9281-7069-5f4e3d2c1b0a",
      "description": "Patient calling to schedule an urgent dental appointment due to severe tooth pain"
    },
    "agentEndpoint": {
      "id": "3c2b1a09-8f7e-6d5c-4b3a-291807060504",
      "name": "PHONE",
      "phoneNumber": "+15555551234",
      "type": "PHONE"
    },
    "createdAt": "2025-01-15T14:23:45.123Z",
    "startedAt": "2025-01-15T14:24:15.456Z",
    "completedAt": "2025-01-15T14:28:32.789Z"
  }
}

Changes

Changed in 3 of the 105 revisions of this API.21312

Aug 26, 2026b4a59c7057ca17See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 404
  response-body-type-changed
- ○
  for the path request parameter jobId, the type/format was generalized from / to string/uuid
  request-parameter-type-generalized
- ○
  added the optional property details to the response with the 404 status
  response-optional-property-added
- ○
  added the optional property param to the response with the 404 status
  response-optional-property-added
- ○
  added the required property code to the response with the 404 status
  response-required-property-added
- ○
  added the required property data/persona/age to the response with the 200 status
  response-required-property-added
- ○
  added the required property message to the response with the 404 status
  response-required-property-added
- ○
  added the required property type to the response with the 404 status
  response-required-property-added
Aug 17, 2026887b091b3d811115See the full diff
- ▲
  the response property data/persona/idleMessages became nullable for the status 200
  response-property-became-nullable
- ●
  added the new DAILY enum value to the data/agentEndpoint/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new HE enum value to the data/persona/language response property for the response status 200
  response-property-enum-value-added
- ●
  added the new IL enum value to the data/persona/accent response property for the response status 200
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 403
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 429
  response-property-enum-value-added
- ●
  added the new conflict enum value to the type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 401
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 403
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 429
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the type response property for the response status 500
  response-property-enum-value-added
- ○
  the idleMessageMaxSpokenCount response's property default value changed from 5 to 3 for the status 200
  response-property-default-value-changed
- ○
  the idleMessageResetCountOnUserSpeechEnabled response's property default value changed from false to true for the status 200
  response-property-default-value-changed
- ○
  the idleMessages response's property default value Are you still there? Hello? Can you hear me? was removed for the status 200
  response-property-default-value-removed
- ○
  added the required property data/persona/understoodLanguages to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/runPlan to the response with the 200 status
  response-required-property-added
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Apr 17, 2026ec9443a8a36f2See the full diff
- ●
  added the new GOOGLE_CES enum value to the data/agentEndpoint/type response property for the response status 200
  response-property-enum-value-added
- ●
  added the new KORE enum value to the data/agentEndpoint/type response property for the response status 200
  response-property-enum-value-added

Full history