Generating

Read a vehicle's settings

A vehicle is a model RP Engine lets players ride: its seats, how it drives, its hitbox, which animation plays in each state, its sounds and its particles. This is the vehicle editor's whole configuration, in the shape POST takes back.

ready is false until it can be ridden (most often, until it has a driver's seat), and unfinishedReason says why.

GET/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.

Response · 200

The vehicle.

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.

Error codes

Branch on error.code, never on the message.

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.

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.