Skip to content

Post robot component summaries (beta)

Beta
POST
/v1/robots/summaries/components
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.

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
firmwareVersion

Firmware version at the time of this call.

string
metadata

Extra fields from the partner. Stored as sent.

object
key
additional properties
any
records
required

Component windows in this call. Send 1 to 500.

Array<object>
>= 1 items <= 500 items
object
robotId
required

Robot id. The robot must already exist.

string
recordedAt
required

When this window ended, as ISO-8601 UTC.

string format: date-time
timezone
required

IANA timezone. Example: Asia/Hong_Kong.

string
periodSeconds
required

Length of this window in seconds. Allowed range is 10 to 60.

integer
>= 10 <= 60
socPct

State of charge as a percent.

number
voltageV

Pack voltage in volts.

number
currentA

Pack current in amperes.

number
packTempC

Pack temperature in Celsius.

number
chargePowerW

Charge power in watts.

number
cycleCount

Charge cycle count.

integer
bmsWarning

Battery warning text.

string
motorCurrentA

Drive current in amperes. Use actuators when there is more than one drive.

number
motorTempC

Drive temperature in Celsius. Use actuators when there is more than one drive.

number
encoderError

True when the encoder reported an error.

boolean
vibration

Vibration reading in the partner’s units.

number
lidarValid

True when lidar data in this window was valid.

boolean
cameraValid

True when camera data in this window was valid.

boolean
localisationConfidence

Localisation confidence from 0 to 1.

number
<= 1
sensorCommsError

True when a sensor link failed.

boolean
surfaceClass

Floor or ground class. Example: tile.

string
slopePct

Slope as a percent.

number
wetOrSlippery

True when the surface was wet or slippery.

boolean
lightingBand

Light level. Preferred words: dark, dim, normal, bright. Other words are stored.

string
tempC

Air temperature in Celsius.

number
humidityPct

Relative humidity as a percent.

number
peopleNearbyBand

How many people were nearby. Preferred words: none, few, many. Other words are stored.

string
obstacleDensityBand

How crowded the space was. Preferred words: clear, sparse, dense. Other words are stored.

string
minClearanceM

Smallest clearance in metres.

number
actuators

One row per actuator, up to 32. Prefer this when there is more than one drive.

Array<object>
<= 32 items
object
name

Actuator name. Examples: drive_left, lift.

string
currentA

Actuator current in amperes.

number
tempC

Actuator temperature in Celsius.

number

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"
}
]
}

Component records stored. accepted equals the number of records.

Media typeapplication/json
object
accepted
required
integer

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.
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"
}
404Unknown `robotId`. Nothing in this call is stored.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "not_found"
}
413More than 500 records. Nothing is stored.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "payload_too_large"
}