Create a Factory run

Create a Factory run (a factory_batch cloud run) under the caller’s credential and workspace. Requires maxCostCents (at least the estimate) and Idempotency-Key; the whole quote is held, and only accepted clips are charged, per camera-second. A replay with the same key and request returns the original run (200).

POST /api/v1/factory/runs

Create a Factory run

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/factory/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "lookIds": [
    "<string>"
  ],
  "maxCostCents": 1,
  "scenarioIds": [
    "<string>"
  ],
  "datasetId": "<string>",
  "mode": "positions",
  "seedsPerLook": 1,
  "cameras": [
    "camera_cross_left_120fov",
    "camera_front_wide_120fov",
    "camera_cross_right_120fov",
    "camera_front_tele_30fov"
  ]
}
'

200

{
  "id": "<string>",
  "status": "queued",
  "mode": "positions",
  "lookIds": [
    "<string>"
  ],
  "seedsPerLook": 123,
  "scenarios": 1,
  "clips": {
    "total": 1,
    "inProgress": 1,
    "accepted": 1,
    "flagged": 1,
    "rejected": 1,
    "failed": 1
  },
  "costEstimateCents": 1,
  "costCents": 1,
  "createdAt": "2023-11-07T05:31:56Z",
  "finishedAt": "2023-11-07T05:31:56Z"
}

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.

Headers

Idempotency-Key · string · required

Required string length: 1 - 200

Body

application/json

lookIds · string[] · required

Looks from GET /api/v1/factory/looks, each once.

Required array length: 1 - 12 elements

Pattern: ^[a-z0-9][a-z0-9-]{0,63}$

maxCostCents · integer · required

The most this run may charge: every clip accepted. Below the estimate, the run is refused budget_exceeded.

Required range: x >= 0

scenarioIds · string[]

The scenarios to make clips of, in this workspace. Exactly one of scenarioIds and datasetId.

Required array length: 1 - 500 elements

Required string length: 1 - 128

datasetId · string

Every scenario of this dataset (one this workspace owns, at most 500). Exactly one of scenarioIds and datasetId.

Required string length: 1 - 128

mode · enum<string> · default: positions

positions: the generator sees the layout and the look. simulator: also each camera's first Helios frame.

Available options: positions, simulator

seedsPerLook · integer · default: 1

Clips per scenario and look, each on its own seed.

Required range: 1 <= x <= 10

cameras · enum<string>[]

The Alpamayo 4-camera rig, the only rig offered: every clip has all four cameras.

Available options: camera_cross_left_120fov, camera_front_wide_120fov, camera_cross_right_120fov, camera_front_tele_30fov

Response

200

application/json

Idempotent replay.

id · string · required

status · enum<string> · required

Available options: queued, running, succeeded, partial, failed, cancelled

mode · enum<string> · required

Available options: positions, simulator

lookIds · string[] · required

Pattern: ^[a-z0-9][a-z0-9-]{0,63}$

seedsPerLook · integer · required

scenarios · integer · required

Required range: x >= 0

clips · object · required

Show child attributes

costEstimateCents · integer | null · required

Required range: x >= 0

costCents · integer | null · required

Required range: x >= 0

createdAt · string<date-time> · required

finishedAt · string<date-time> | null · required