Import a vehicle

Store the model an upload of kind vehicle-model holds as the workspace's own vehicle workspace.<id>, private to it; the server re-validates it against the vehicle model contract

POST /api/v1/vehicles

Import a vehicle

cURL

curl --request POST \
  --url https://dev.simforge.ai/api/v1/vehicles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "license": "<string>",
  "attribution": "<string>",
  "uploadId": "<string>",
  "name": "<string>",
  "dims": [
    123,
    123,
    123
  ],
  "licenseText": "<string>",
  "source": "<string>"
}
'

201

{
  "catalogId": "<string>",
  "name": "<string>",
  "source": "shared",
  "vehicleClass": "<string>",
  "dims": {
    "length": 123,
    "width": 123,
    "height": 123
  },
  "license": "<string>",
  "attribution": "<string>",
  "glbSha256": "<string>",
  "wheels": true,
  "tintable": true,
  "createdAt": "<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

id · string · required

Pattern: ^[a-z0-9_-]{1,48}$

vehicleClass · enum<string> · required

Available options: car, van, truck, bus

license · string · required

Pattern: ^(?:LicenseRef-[A-Za-z0-9.-]{1,100}|[A-Za-z0-9][A-Za-z0-9.+-]{0,63})$

attribution · string · required

Required string length: 1 - 1000

uploadId · string · required

name · string

Required string length: 1 - 120

dims · tuple

Show child attributes

licenseText · string

Required string length: 1 - 20000

source · string

Required string length: 1 - 1000

Response

201

application/json

The stored vehicle.

catalogId · string · required

Minimum string length: 1

name · string · required

source · enum<string> · required

Available options: shared, workspace

vehicleClass · string · required

dims · object · required

Show child attributes

license · string

attribution · string

glbSha256 · string

wheels · boolean

tintable · boolean

createdAt · string