Temi RESTful API (1.0.0)

Validates the OAT and returns organization, scope, and robot access metadata.

Returns PRO robots accessible to this token (identity fields only). BASIC robots are omitted.

Required scope: read:org:info

Returns identity, presence, and last-known activity for a single PRO robot. status is online, offline, busy, or privacy. Privacy is reported even though the robot publishes MQTT presence as offline.

Optional movement, sequence, call, and battery come from retained MQTT (same topics Center uses). They are omitted when the broker has no payload.

Polling after play

1. Play a sequence whose last action is MOVEMENT to home base.
2. Poll this endpoint until sequence.status is not start (complete, abort, or absent) and movement.type is idle (or go_to with status: complete and location = home base).
3. Then send the next room.

START_CALL holds the sequence until the call ends. Meanwhile call.status is start (ringing or connected). call.hostId is the meeting host from retained telepresence extra.

Required scope: read:robot:status

Returns named map locations for a PRO robot. Use these names as extra.locationName in MOVEMENT actions.

Required scope: read:robot:locations

Returns project members of this robot who can receive a START_CALL. Only root, admin, collaborator, and guest roles with access to this robot are included. Org/robot contacts who are not members do not appear — add them as a member in Center first.

name uses the organization Contacts display name when available, otherwise the member login username.

Each temiId is unique in the list. Use it in START_CALL contactIds.

Required scope: read:robot:contact

Validates a sequence request body without persisting or dispatching it. Use this to check action layout, required fields, and resolvable contacts before execution. This endpoint does not check whether the robot is currently online, in Privacy mode, or busy.

Required scope: action:robot:sequence

Runs a sequence on a robot. A sequence is an ordered list of actions (navigate, speak, place a video call). The request is accepted asynchronously; the robot executes the sequence after delivery.

Recommended flow

1. GET /robots — select a robot by serialNumber
2. GET /robots/{serialNumber} — confirm status is online
3. GET /robots/{serialNumber}/locations — resolve location names for navigation
4. GET /robots/{serialNumber}/contacts — resolve temiId for calls
5. POST /sequences/play — submit the sequence with serialNumber
6. Poll GET /robots/{serialNumber} until the sequence finished and the robot is idle / at home base.

Play is accepted only when the robot is online and not in Privacy mode. Privacy, offline, and busy return 409 with robot_privacy, robot_offline, or robot_busy. Check status before play.

Path parameters and play/validate bodies use hardware serialNumber only.

Supported action types

Compact requests may use step instead of startStep/endStep. See the minimal example.

Constraints

• Every action must include type and either step or startStep/endStep.
• For a single-step action, set startStep and endStep to the same value (or use step).
• Sequences must include step 1, with a final action on every consecutive step.
• MOVEMENT and SPEAK may share a step. START_CALL must not share a step with MOVEMENT or SPEAK (overlap is rejected).
• START_CALL must start and end on the same step. finalInEndStep can be omitted; the server always sets it to true.
• START_CALL requires contactIds (a non-empty array of unique temiIds after trim). Duplicates are rejected. One id is a 1:1 call; two or more is a group call.
• Call destination is the same as Center: mobile (temi phone app), web (temi Center), or both (phone and Center, default). Each contact may set its own platform; otherwise the action-level platform applies to every invited person.
• repeatSequence must be an integer >= -1 (-1 = infinite repeat).
• startFromStep must be an integer >= 1 and not beyond the last sequence step.
• Callers should take MOVEMENT location names from GET /robots/{serialNumber}/locations.
• For SPEAK language: omit or use "" to use the robot's current TTS language. See SpeakExtra.language for supported locales. If the requested locale is unavailable on the robot, speech uses the current system TTS.
• Play is rejected with 409 when the robot is in Privacy mode, offline, or busy.

Required scope: action:robot:sequence

Stops an OpenAPI sequence that is currently running on a robot. Only the same Organization Access Token that called POST /sequences/play may stop that run, using the sequenceId returned from play.

The server confirms the robot is still running that sequence (retained sequence.sequenceId from GET /robots/{serialNumber}) before dispatching MQTT stop. This avoids halting a different sequence that started later.

Required scope: action:robot:sequence