Download the runtime

Sign a download of an entitled runtime release (CLI credential, runtime:read): the full (3d) release, or with variant: "2d" the same release without its 3D actor models and sky plates

POST /api/v1/distribution/runtime

Download the runtime

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/distribution/runtime \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "version": "<string>",
  "dryRun": true
}
'

200

{
  "schema": "simforge.distribution-download/v1",
  "kind": "runtime",
  "name": "<string>",
  "version": "<string>",
  "url": "<string>",
  "sha256": "<string>",
  "bytes": 123,
  "expiresAt": "<string>",
  "agreementVersion": "<string>",
  "manifest": {},
  "target": "<string>",
  "variant": "3d",
  "blobPack": {
    "index": {
      "url": "<string>",
      "sha256": "<string>",
      "bytes": 123,
      "signature": {}
    },
    "data": {
      "url": "<string>",
      "bytes": 1
    }
  }
}

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

target · enum<string> · required

Available options: x86_64-unknown-linux-gnu, aarch64-apple-darwin, x86_64-apple-darwin, x86_64-pc-windows-gnu

version · string

Pattern: ^[0-9A-Za-z][0-9A-Za-z.+_-]{0,63}$

variant · enum<string>

Available options: 3d, 2d

dryRun · boolean

Response

200

application/json

A signed URL valid for at most 15 minutes, or with dryRun: true the plan of that download (nothing signed or recorded).

Option 1

Option 2

schema · enum<string> · required

Available options: simforge.distribution-download/v1

kind · enum<string> · required

Available options: runtime, map, cli

name · string · required

version · string · required

url · string<uri> · required

sha256 · string · required

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

bytes · integer · required

expiresAt · string · required

agreementVersion · string · required

manifest · object · required

Show child attributes

target · string

variant · enum<string>

Available options: 3d, 2d

blobPack · object

Show child attributes