Simulation Run Plan Job

Get simulation plan job

Retrieve details of a simulation plan job including all associated simulation jobs (calls)

get/v1/simulation/plan/job/{jobId}

Path parameters

jobIdstring uuid required

Simulation run plan job ID

Response

Successfully retrieved simulation plan job

Example response

{
  "data": {
    "simulationRunPlanJobId": "7f3e4d2c-8a91-4b5c-9e6f-1a2b3c4d5e6f",
    "simulationRunPlanId": "9a8b7c6d-5e4f-3210-abcd-ef9876543210",
    "status": "RUNNING_SIMULATIONS",
    "createdAt": "2024-01-15T10:30:00Z",
    "startedAt": "2024-01-15T10:30:15Z",
    "endedAt": null,
    "simulationJobs": [
      {
        "simulationJobId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "status": "COMPLETED",
        "processingStatus": "COMPLETED",
        "callId": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "roarkPhoneNumber": "+15551234567",
        "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"
        },
        "agentEndpoint": {
          "id": "3c2b1a09-8f7e-6d5c-4b3a-291807060504",
          "name": "PHONE",
          "phoneNumber": "+15555551234",
          "type": "PHONE"
        },
        "createdAt": "2024-01-15T10:30:20Z",
        "startedAt": "2024-01-15T10:30:25Z",
        "completedAt": "2024-01-15T10:32:45Z"
      }
    ]
  }
}

Changes

Changed in 5 of the 111 revisions of this API.21612

Sep 3, 20266a09e09bd1ca1See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
Aug 26, 2026b4a59c7057ca17See the full diff
- ▲
  the response's body type changed from no type to object for status
  response-body-type-changed
- ○
  for the path request parameter jobId, the type was generalized from no type to string, and format from no format to uuid
  request-parameter-type-generalized
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property //// to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
- ○
  added the required property to the response with the status
  response-required-property-added
Aug 20, 20269080f23131181See the full diff
- ●
  added the new PREPARING_CAPACITY enum value to the / response property for the response status
  response-property-enum-value-added
Aug 17, 2026887b091b3d811134See the full diff
- ▲
  the response property //// became nullable for the status
  response-property-became-nullable
- ●
  added the new DAILY enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new HE enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new IL enum value to the //// response property for the response status
  response-property-enum-value-added
- ●
  added the new PENDING enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new WAITING_FOR_LIVE_CONVERSATION enum value to the /// response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new conflict enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new payment_required enum value to the response property for the response status
  response-property-enum-value-added
- ○
  the response's property default value changed from 5 to 3 for the status
  response-property-default-value-changed
- ○
  the response's property default value changed from false to true for the status
  response-property-default-value-changed
- ○
  the response's property default value Are you still there? Hello? Can you hear me? was removed for the status
  response-property-default-value-removed
- ○
  added the required property //// to the response with the 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 //// response property for the response status
  response-property-enum-value-added
- ●
  added the new KORE enum value to the //// response property for the response status
  response-property-enum-value-added

Full history