Skip to content

Create or replace robot (beta)

Beta
PUT
/v1/robots/{robotId}
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.

robotId
required
string

Example

rbt_example
Media typeapplication/json
object
partnerId
required

Partner id. It must match the server key.

string
schemaVersion
required

Schema version of this body. Example: 2026-11.

string
sourceSystem
required

Name of the system that sent this body. Example: partner-export.

string
model
required

Robot model name.

string
serial
required

Serial number.

string
vin

Vehicle identification number, when the robot has one.

string
massKg

Mass in kilograms.

number
lengthM

Length in metres.

number
widthM

Width in metres.

number
heightM

Height in metres.

number
ratedSpeedMps

Rated speed in metres per second.

number
maxSpeedMps

Top speed this robot is built for, in metres per second.

number
batteryType

Battery chemistry or pack type. Example: lithium.

string
batteryCapacityWh

Battery capacity in watt-hours.

number
sensorSuite

Sensor names on this robot. Example: lidar.

Array<string>
controller

Controller name.

string
firmwareVersion

Firmware version at the time of this call.

string
deployedOn

Date the robot was deployed, as YYYY-MM-DD.

string format: date
metadata

Extra fields from the partner. Stored as sent.

object
key
additional properties
any

Example

{
"partnerId": "partner",
"schemaVersion": "2026-11",
"sourceSystem": "partner-export",
"model": "M1",
"serial": "SN-1001",
"vin": "VIN-1001",
"firmwareVersion": "1.4.2"
}

Robot stored. A later call replaces it.

Media typeapplication/json
object
robotId
required
string
updatedAt
required
string format: date-time

Example

{
"robotId": "rbt_example",
"updatedAt": "2026-10-15T10:00:00.000Z"
}
400A required field is missing.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "invalid_body"
}
401The server key is missing or wrong.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

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.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "forbidden"
}