Simulation Run Plan Job

Get simulation plan job

Changed on

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

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

Request

  • Base URL
    https://api.roark.ai
  • URL
    https://api.roark.ai/v1/simulation/plan/job/{jobId}
  • Auth
    HTTP bearer

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",
        "invalidation": null,
        "retryOfSimulationJobId": null,
        "attemptNumber": 1,
        "scheduledAt": null,
        "persona": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "Sarah Johnson - Anxious Patient",
          "displayName": "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",
          "interruption": "OCCASIONAL",
          "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"
        },
        "backgroundNoise": {
          "backgroundNoise": "CITY",
          "backgroundNoiseVolume": 0.1,
          "source": "ENVIRONMENT"
        },
        "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"
      }
    ],
    "attemptSummary": {
      "testCaseCount": 1,
      "attemptCount": 1,
      "silentAttemptCount": 0,
      "retryCount": 0,
      "stillSilentTestCaseCount": 0
    },
    "pendingRetries": []
  }
}

Changes

    • info

      added the required property ////////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • warning

      added the new RETRY_SCHEDULED enum value to the /// response property for the response status

    • info

      added the optional property ///////// to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property ////// to the response with the status

    • info

      added the required property //////// to the response with the status

    • info

      added the required property //////// to the response with the status