Post robot component summaries (beta)
const url = 'https://api.example.yas/v1/robots/summaries/components';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"partnerId":"partner","schemaVersion":"2026-11","sourceSystem":"partner-export","records":[{"robotId":"rbt_example","recordedAt":"2026-10-15T10:01:00.000Z","timezone":"Asia/Hong_Kong","periodSeconds":60,"socPct":72,"peopleNearbyBand":"few"}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.example.yas/v1/robots/summaries/components \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "records": [ { "robotId": "rbt_example", "recordedAt": "2026-10-15T10:01:00.000Z", "timezone": "Asia/Hong_Kong", "periodSeconds": 60, "socPct": 72, "peopleNearbyBand": "few" } ] }'Beta. Post 1 to 500 component records with the server key. Each record covers 10 to 60 seconds and needs robotId, recordedAt, timezone, and periodSeconds. Battery, drive, perception, and surroundings fields are optional. Current and temperature stay on this call. Send one row per actuator in actuators, up to 32. A single drive may still use motorCurrentA and motorTempC. Send bands and classes only. Do not send video, audio, or a person’s name. The robot must already exist for this partnerId. An unknown robotId is 404; nothing in the call is stored. An empty list, a missing field, periodSeconds outside 10 to 60, or more than 32 actuators is 400. More than 500 records is 413. Records have no id. Post the same window again and YAS stores another row. accepted equals the number of records.
Authorizations
Section titled “Authorizations”Request 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.
Firmware version at the time of this call.
Extra fields from the partner. Stored as sent.
object
Component windows in this call. Send 1 to 500.
object
Robot id. The robot must already exist.
When this window ended, as ISO-8601 UTC.
IANA timezone. Example: Asia/Hong_Kong.
Length of this window in seconds. Allowed range is 10 to 60.
State of charge as a percent.
Pack voltage in volts.
Pack current in amperes.
Pack temperature in Celsius.
Charge power in watts.
Charge cycle count.
Battery warning text.
Drive current in amperes. Use actuators when there is more than one drive.
Drive temperature in Celsius. Use actuators when there is more than one drive.
True when the encoder reported an error.
Vibration reading in the partner’s units.
True when lidar data in this window was valid.
True when camera data in this window was valid.
Localisation confidence from 0 to 1.
True when a sensor link failed.
Floor or ground class. Example: tile.
Slope as a percent.
True when the surface was wet or slippery.
Light level. Preferred words: dark, dim, normal, bright. Other words are stored.
Air temperature in Celsius.
Relative humidity as a percent.
How many people were nearby. Preferred words: none, few, many. Other words are stored.
How crowded the space was. Preferred words: clear, sparse, dense. Other words are stored.
Smallest clearance in metres.
One row per actuator, up to 32. Prefer this when there is more than one drive.
object
Actuator name. Examples: drive_left, lift.
Actuator current in amperes.
Actuator temperature in Celsius.
Example
{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "records": [ { "robotId": "rbt_example", "recordedAt": "2026-10-15T10:01:00.000Z", "timezone": "Asia/Hong_Kong", "periodSeconds": 60, "socPct": 72, "peopleNearbyBand": "few" } ]}Responses
Section titled “Responses”Component records stored. accepted equals the number of records.
object
Example
{ "accepted": 1}400The records list is empty, a required field is missing, `periodSeconds` is outside 10 to 60, or `actuators` has more than 32 items.
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"}404Unknown `robotId`. Nothing in this call is stored.
object
Stable error code. No stack trace.
Example
{ "error": "not_found"}413More than 500 records. Nothing is stored.
object
Stable error code. No stack trace.
Example
{ "error": "payload_too_large"}