Skip to content

Complete robot map (beta)

Beta
POST
/v1/robots/maps/complete
curl --request POST \
--url https://api.example.yas/v1/robots/maps/complete \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "partnerId": "partner", "schemaVersion": "2026-11", "sourceSystem": "partner-export", "robotId": "rbt_example", "mapId": "map_1" }'

Beta. Complete makes the map live. Send partnerId, schemaVersion, sourceSystem, robotId, and mapId. PUT the bytes to the minted URL first. An unknown robotId or map is 404. The first complete returns status ready and updatedAt as ISO-8601 UTC. A repeat when the map is already live is 200 with status ready and no updatedAt. Complete within 24 hours of minting. A missing upload is 409 upload_incomplete; a size or type mismatch is 422 invalid_media. A credential may expire before the completion deadline: an already uploaded valid object can still complete. Mint again for invalid content because objects cannot be overwritten.

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
robotId
required

Robot id. The robot must already exist.

string
mapId
required

Map id from mint. The live map changes when complete succeeds.

string

Example

{
"partnerId": "partner",
"schemaVersion": "2026-11",
"sourceSystem": "partner-export",
"robotId": "rbt_example",
"mapId": "map_1"
}

Map is live. status is ready. updatedAt is ISO-8601 UTC on the first complete. A repeat when the map is already live is 200 with status ready and no updatedAt.

Media typeapplication/json
object
robotId
required
string
mapId
required
string
status
required

ready means the map is live.

string
Allowed values: ready
updatedAt

ISO-8601 UTC on the first complete. A repeat when the map is already live omits this field.

string format: date-time

Example

{
"robotId": "rbt_example",
"mapId": "map_1",
"status": "ready",
"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"
}
404Unknown `robotId` or map. Nothing is stored.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "not_found"
}
409No completed object is available yet. Upload before the credential expires and retry complete.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "upload_incomplete"
}
410The 24-hour completion deadline has expired. Mint again; a previous ready map is unchanged.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "upload_expired"
}
422The uploaded object does not match its declared size or type. Mint again and upload valid bytes; the object cannot be overwritten.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "invalid_media"
}
503Storage or its required configuration is unavailable. Retry after the Retry-After interval.
Media typeapplication/json
object
error
required

Stable error code. No stack trace.

string

Example

{
"error": "unavailable"
}