Generating

Make a model a vehicle, or change its settings

Turns a model into a vehicle when it is not one yet (its geometry is untouched; converted says it happened), and saves vehicle when sent. Send nothing to convert only.

vehicle is the whole configuration, in the shape GET answers: read it, change what you want, send it back. Values out of range are corrected rather than refused, and the answer is what was stored, so read it rather than assuming. Seat positions are in the model's pixels, a seat at yaw 0 faces the way the vehicle drives, and one seat must be the driver's. A 3D item's model cannot be a vehicle. Free.

To animate the vehicle and its riders together, POST /packs/{pack}/vehicles/{model}/rig.

POST/packs/{pack}/vehicles/{model}

Path parameters

packstringrequired

The pack's slug, as returned by the packs endpoints.

modelstringrequired

The model's name from the listing.

Body

vehicleobject

The whole configuration: medium (land, water or air), speed, acceleration, turnSpeed, turnInPlace, weight, scale, jump, hitbox, flight, seats, animations (state to the model's animation name), sounds, capes, vehicleStatus and particles.

Response · 200

Saved. The vehicle as stored.

packstringrequired

The pack.

modelstringrequired

The vehicle's model name.

vehicleobjectrequired

The whole configuration, the shape POST takes.

readybooleanrequired

Whether it can be ridden.

unfinishedReasonstringrequired

Why it cannot be ridden yet, or null.

convertedboolean

True when this call made the model a vehicle. Absent otherwise.

Error codes

Branch on error.code, never on the message.

invalid_json400

The request body wasn't a JSON object.

invalid_request400

Something in the body or query is wrong. message says what.

invalid_api_key401

The key isn't one of ours, or it has been revoked.

missing_api_key401

No Authorization: Bearer header was sent.

wrong_key_kind401

An MCP key sent to the REST API, or an API key sent to the MCP server. Each only opens its own.

account_suspended403

The account is suspended, so its keys open nothing. message says until when, if the suspension has an end date.

forbidden403

Valid key, but not permitted to do this in this pack.

plan_required403

The key is valid, but its account is on Starter. The API needs a paid plan.

not_found404

No such pack, asset or job.