Get a closed-loop run's replay

GET /api/v1/runs/{id}/replay

Get a closed-loop run's replay

cURL

curl --request GET \
  --url https://dev.simforge.ai/api/v1/runs/{id}/replay \
  --header 'Authorization: Bearer <token>'

200

{
  "runId": "<string>",
  "scenarioId": "<string>",
  "revisionId": "<string>",
  "mapVersionId": "<string>",
  "egoActorId": "<string>",
  "timelineSha256": "<string>",
  "timeline": {
    "artifactId": "<string>",
    "sha256": "<string>",
    "sizeBytes": 1,
    "url": "<string>",
    "expiresAt": "<string>"
  },
  "plan2d": {
    "sha256": "<string>",
    "sizeBytes": 1,
    "url": "<string>"
  }
}

Authorizations

Authorization · string · header · required

A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.

Path Parameters

id · string · required

Query Parameters

scenarioId · string

The scenario whose episode to replay. Required when the run drove several scenarios (replay_scenario_required lists them); a run of one scenario replays it without.

Response

200

application/json

The closed-loop run's replay: one episode's render timeline and the 2D map.

runId · string · required

scenarioId · string · required

revisionId · string · required

mapVersionId · string · required

egoActorId · string | null · required

timelineSha256 · string · required

timeline · object · required

Show child attributes

plan2d · object | null · required

Show child attributes