Simulation Run Plan Job

Generate simulation run debrief

Changed on

Request the written debrief for a settled run: executive summary, failure themes and recommendations. Runs with graded calls get one automatically, so this is for regenerating one (regenerate: true) or retrying one that failed.

Returns immediately. Generation takes a few minutes: poll GET /v1/simulation/plan/job/{jobId}/results until debrief.status is READY or FAILED. Without regenerate, a debrief that is ready or already being written is returned as-is.

post/v1/simulation/plan/job/{jobId}/debrief

Request

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

Path parameters

jobIdstring uuid required

Simulation run plan job ID

Request body

regenerateboolean

Generate a new debrief even when a ready one exists. Without it, an existing ready or in-progress debrief is returned as-is.

Response

The debrief, as requested or as it already stands

Example response

{
  "data": {
    "debriefId": "3c2b1a09-8f7e-4d6c-9b5a-4e3d2c1b0a9f",
    "status": "GENERATING",
    "errorMessage": null,
    "createdAt": "2026-10-11T14:05:12.000Z",
    "completedAt": null,
    "report": null
  }
}

Changes