Create or replace robot (beta)
const url = 'https://api.example.yas/v1/robots/rbt_example';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"partnerId":"partner","schemaVersion":"2026-11","sourceSystem":"partner-export","model":"M1","serial":"SN-1001","vin":"VIN-1001","firmwareVersion":"1.4.2"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.example.yas/v1/robots/rbt_example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "model": "M1", "serial": "SN-1001", "vin": "VIN-1001", "firmwareVersion": "1.4.2" }'Beta. Create or replace a robot with the server key. Send partnerId, schemaVersion, sourceSystem, model, and serial. A later call replaces the stored body. Leave an optional field out and it is cleared. updatedAt is ISO-8601 UTC.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Example
rbt_exampleRequest Bodyrequired
Section titled “Request Bodyrequired”object
Partner id. It must match the server key.
Schema version of this body. Example: 2026-11.
Name of the system that sent this body. Example: partner-export.
Robot model name.
Serial number.
Vehicle identification number, when the robot has one.
Mass in kilograms.
Length in metres.
Width in metres.
Height in metres.
Rated speed in metres per second.
Top speed this robot is built for, in metres per second.
Battery chemistry or pack type. Example: lithium.
Battery capacity in watt-hours.
Sensor names on this robot. Example: lidar.
Controller name.
Firmware version at the time of this call.
Date the robot was deployed, as YYYY-MM-DD.
Extra fields from the partner. Stored as sent.
object
Example
{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "model": "M1", "serial": "SN-1001", "vin": "VIN-1001", "firmwareVersion": "1.4.2"}Responses
Section titled “Responses”Robot stored. A later call replaces it.
object
Example
{ "robotId": "rbt_example", "updatedAt": "2026-10-15T10:00:00.000Z"}400A required field is missing.
object
Stable error code. No stack trace.
Example
{ "error": "invalid_body"}401The server key is missing or wrong.
object
Stable error code. No stack trace.
Example
{ "error": "invalid_credentials"}403A server key may be limited to vehicles, robots, or both. A call outside that limit is 403 `forbidden` and stores nothing. `identity_mismatch` means `partnerId` does not match the server key.
object
Stable error code. No stack trace.
Example
{ "error": "forbidden"}