Download an artifact

GET /api/v1/artifacts/{id}/download

Download an artifact

cURL

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

200

{
  "url": "<string>",
  "expiresAt": "<string>",
  "sha256": "<string>",
  "sizeBytes": 1,
  "mediaType": "<string>",
  "rendition": "preview"
}

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

rendition · enum<string>

preview: what a player streams of a render's camera clip, its lower-bitrate preview copy when it has one, else the clip itself; the response's rendition says which. Without it the download is always the artifact itself.

Available options: preview

Response

200

application/json

Presigned artifact download.

url · string · required

Minimum string length: 1

expiresAt · string · required

sha256 · string · required

sizeBytes · integer · required

Required range: x >= 0

mediaType · string · required

rendition · enum<string>

Available options: preview, original