Maps and vehicles
List vehicles
List the vehicles a scenario in the current workspace can bind: the shared catalog’s, then the workspace’s own
GET
/
api
/
v1
/
vehicles
List vehicles
curl --request GET \
--url https://dev.simforge.ai/api/v1/vehicles \
--header 'Authorization: Bearer <token>'import requests
url = "https://dev.simforge.ai/api/v1/vehicles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://dev.simforge.ai/api/v1/vehicles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"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>"
}
],
"nextCursor": "<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
A sfc_at_… access token from simforge login, or an sfk_… API key. An operation's security lists the scopes the credential must hold.
Query Parameters
Minimum string length:
1Required range:
1 <= x <= 100⌘I
List vehicles
curl --request GET \
--url https://dev.simforge.ai/api/v1/vehicles \
--header 'Authorization: Bearer <token>'import requests
url = "https://dev.simforge.ai/api/v1/vehicles"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://dev.simforge.ai/api/v1/vehicles', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));{
"data": [
{
"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>"
}
],
"nextCursor": "<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>"
}
}