---
title: "Get simulation plan job"
method: GET
path: "/v1/simulation/plan/job/{jobId}"
tags: ["Simulation Run Plan Job"]
---

# Get simulation plan job

`GET /v1/simulation/plan/job/{jobId}`

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

## Path parameters

- `jobId` unknown, required

## Response `200`

Successfully retrieved simulation plan job

- object
  - `data` GetSimulationPlanJobResponse, required — Simulation run plan job with all associated simulation jobs
    - `simulationRunPlanJobId` string, uuid, required — ID of the simulation run plan job
    - `simulationRunPlanId` string, uuid, required — ID of the simulation run plan
    - `status` 'PENDING' | 'QUEUED' | 'CREATING_SNAPSHOTS' | 'CREATING_SIMULATIONS' | 'RUNNING_SIMULATIONS' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING' | 'ENDING_SIMULATIONS', required — Job status
    - `createdAt` string, required — When the job was created
    - `startedAt` string, nullable — When the job started
    - `endedAt` string, nullable — When the job ended
    - `simulationJobs` object[], required — List of simulation jobs (calls) in this run plan job
      - `simulationJobId` string, uuid, required — Simulation job ID
      - `status` 'PENDING' | 'QUEUED' | 'PROCESSING' | 'COMPLETED' | 'FAILED' | 'TIMED_OUT' | 'CANCELLED' | 'CANCELLING', required — Job status
      - `processingStatus` 'CONNECTING' | 'WAITING_FOR_OUTBOUND_CALL' | 'SIMULATING' | 'ENDING' | 'ANALYZING' | 'EVALUATING' | 'COLLECTING_METRICS' | 'COMPLETED', required — Processing status
      - `callId` string, uuid, nullable — ID of the call created for this simulation job. Null if the call has not been created yet.
      - `roarkPhoneNumber` string, nullable — Phone number provisioned by Roark for this simulation job in E.164 format. Null if the simulation job is queued and has not been assigned a phone number yet.
      - `persona` object, required
        - `id` string, uuid, required — Unique identifier of the persona
        - `name` string, required — The name the agent will identify as during conversations
        - `description` string, nullable — Human-readable description of the persona
        - `language` 'EN' | 'ES' | 'DE' | 'HI' | 'FR' | 'NL' | 'AR' | 'EL' | 'IT' | 'ID' | 'TH' | 'JA' | 'TL' | 'MS' | 'ZH' | 'TR' | 'PT', required — Primary language ISO 639-1 code for the persona
        - `secondaryLanguage` 'EN', nullable — Secondary language ISO 639-1 code for code-switching (e.g., Hinglish, Spanglish)
        - `accent` 'US' | 'US_X_SOUTH' | 'GB' | 'ES' | 'DE' | 'IN' | 'FR' | 'NL' | 'SA' | 'GR' | 'AU' | 'IT' | 'ID' | 'TH' | 'JP' | 'NZ' | 'PH' | 'SG' | 'MY' | 'HK' | 'TR' | 'PT', required — Accent of the persona, defined using ISO 3166-1 alpha-2 country codes with optional variants
        - `gender` 'MALE' | 'FEMALE', required — Gender of the persona
        - `backgroundNoise` 'NONE' | 'AIRPORT' | 'CHILDREN_PLAYING' | 'CITY' | 'COFFEE_SHOP' | 'DRIVING' | 'OFFICE' | 'THUNDERSTORM', required — Background noise setting
        - `speechPace` 'SUPER_SLOW' | 'SLOW' | 'NORMAL' | 'FAST' | 'SUPER_FAST', required — Speech pace of the persona
        - `speechClarity` 'CLEAR' | 'VAGUE' | 'RAMBLING', required — Speech clarity of the persona
        - `hasDisfluencies` boolean, required — Whether the persona uses filler words like "um" and "uh"
        - `baseEmotion` 'NEUTRAL' | 'CHEERFUL' | 'CONFUSED' | 'FRUSTRATED' | 'SKEPTICAL' | 'RUSHED' | 'DISTRACTED', required — Base emotional state of the persona
        - `intentClarity` 'CLEAR' | 'INDIRECT' | 'VAGUE', required — How clearly the persona expresses their intentions
        - `confirmationStyle` 'EXPLICIT' | 'VAGUE', required — How the persona confirms information
        - `memoryReliability` 'HIGH' | 'LOW', required — How reliable the persona's memory is
        - `responseTiming` 'RELAXED' | 'NORMAL' | 'QUICK', required — Controls how quickly the persona responds to pauses in conversation (QUICK, NORMAL, RELAXED)
        - `backstoryPrompt` string, nullable — Background story and behavioral patterns for the persona
        - `idleMessages` string[], required — Messages the persona will say when the agent goes silent during a call
        - `idleTimeoutSeconds` integer, required — Seconds of silence before the persona sends an idle message
        - `idleMessageMaxSpokenCount` integer, required — Maximum number of idle messages the persona will send before giving up
        - `idleMessageResetCountOnUserSpeechEnabled` boolean, required — Whether the idle message counter resets when the agent speaks
        - `properties` object, required — Additional custom properties about the persona
        - `createdAt` string, required — Creation timestamp
        - `updatedAt` string, required — Last update timestamp
      - `scenario` ScenarioResponse, required — Scenario used in a simulation
        - `id` string, uuid, required — Scenario ID
        - `description` string, nullable — Scenario description
      - `agentEndpoint` AgentEndpointResponse, required — Agent endpoint used in a simulation
        - `id` string, uuid, required — Agent endpoint ID
        - `name` string, required — Agent endpoint name
        - `phoneNumber` string, nullable, required — Agent endpoint phone number
        - `type` 'PHONE' | 'WEBSOCKET' | 'LIVEKIT' | 'SMALL_WEBRTC' | 'ELEVENLABS_WS' | 'KORE' | 'GOOGLE_CES', required — Agent endpoint type
      - `createdAt` string, required — When the simulation job was created
      - `startedAt` string, nullable — When the simulation job started
      - `completedAt` string, nullable — When the simulation job completed

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Simulation plan job not found
- `429` — Too Many Requests
- `500` — Internal Server Error

---

[API](https://skmtc.net/roarkhq/apis/roark-analytics-api.md) · [All operations](https://skmtc.net/roarkhq/apis/roark-analytics-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/roarkhq/roark-analytics-api/revisions/83528d3618ef/schema)