Get a recording

GET /api/v1/recordings/{sha256}

Get a recording

cURL

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

200

{
  "sha256": "<string>",
  "sourceKind": "log",
  "producer": "<string>",
  "clipRef": "<string>",
  "licence": "<string>",
  "map": {
    "mapId": "<string>",
    "version": "<string>",
    "xodrSha256": "<string>"
  },
  "tickCount": 1,
  "actorCount": 1,
  "sizeBytes": 123,
  "createdAt": "<string>",
  "url": "<string>",
  "expiresAt": "<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

sha256 · string · required

Pattern: ^[a-f0-9]{64}$

Response

200

application/json

Recording and a time-limited download URL.

sha256 · string · required

Pattern: ^[a-f0-9]{64}$

sourceKind · enum<string> · required

Available options: log, manual-drive, rollout, openscenario

producer · string · required

clipRef · string · required

licence · string | null · required

map · object | null · required

Show child attributes

tickCount · integer · required

Required range: x >= 0

actorCount · integer · required

Required range: x >= 0

sizeBytes · integer · required

createdAt · string · required

url · string · required

Minimum string length: 1

expiresAt · string · required