Store a recording

POST

api

recordings

Store a recording

curl --request POST \
  --url https://dev.simforge.ai/api/v1/recordings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uploadId": "<string>"
}
'

import requests

url = "https://dev.simforge.ai/api/v1/recordings"

payload = { "uploadId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({uploadId: '<string>'})
};

fetch('https://dev.simforge.ai/api/v1/recordings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<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.

Body

application/json

uploadId

string

required

Response

Stored recording (idempotent by digest).

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

⌘I

Store a recording

curl --request POST \
  --url https://dev.simforge.ai/api/v1/recordings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "uploadId": "<string>"
}
'

import requests

url = "https://dev.simforge.ai/api/v1/recordings"

payload = { "uploadId": "<string>" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({uploadId: '<string>'})
};

fetch('https://dev.simforge.ai/api/v1/recordings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

{
  "error": {
    "code": "bad_request",
    "reason": "<string>",
    "retryable": true,
    "requestId": "<string>",
    "hint": "<string>",
    "param": "<string>",
    "detail": "<unknown>",
    "path": "<string>"
  }
}

Cloud API

Endpoints

Store a recording

Authorizations

Body

Response