Skip to navigation
RESTTasks

Send manual control frame

Preview

Sends a single manual control frame, for example, joystick input, for a manual control task.

Call this endpoint repeatedly to control the asset executing the task. Lattice forwards each frame to the executing agent, which receives it using the stream manual control frames endpoint. The task must be in STATUS_EXECUTING.

The client manages the control session. When it begins controlling, it generates a sessionEpochMicros and includes it in every request, along with a sequence that increases with each frame. A higher epoch replaces the current session, which allows another operator to take over control. A lower epoch is rejected as stale.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

taskIdstringRequired
The ID of the manual control task to send the frame for.

Request

This endpoint expects an object.
sessionEpochMicrosstringRequired
Unix timestamp in microseconds identifying the control session. The client generates this value when it begins a control session, and includes the same value in every request for that session. Higher values replace previous sessions. Lower values are rejected as stale.
sequencestringOptional

The sequence number of this frame within the current session. The client must increase it with each frame so that agents can detect out-of-order delivery. Reset it to 1 when starting a new session.

specificationobjectOptional
The control instructions for this frame. The format is specific to the task, and is passed through to the agent without being inspected by Lattice.

Response

The manual control frame was accepted.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error