For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Logo
ContactLearn More
GuidesReferenceSamplesLicenseChangelog
GuidesReferenceSamplesLicenseChangelog
  • SDKs
    • Overview
  • REST
  • gRPC
        • UNARYCreateTask
        • UNARYGetTask
        • UNARYQueryTasks
        • UNARYUpdateStatus
        • UNARYCancelTask
        • STREAMListenAsAgent
        • STREAMListenForManualControlFrames
        • STREAMStreamTasks
ContactLearn More
gRPCanduril.taskmanager.v1TaskManagerAPI

ListenForManualControlFrames

Example request
1{
2  "task_id": "example"
3}
Example response
1{
2  "frame": {
3    "task_id": "example",
4    "epoch_micros": 42,
5    "sequence": 42,
6    "creation_time": {
7      "seconds": 42,
8      "nanos": 42
9    },
10    "specification": {
11      "type_url": "example",
12      "value": "bytes"
13    }
14  }
15}
Establishes a server streaming connection for receiving manual control frames for a specific task. Agents call this RPC to subscribe to manual control frames for a task they are executing. Task Manager forwards frames from the operator's `SendManualControlFrames` stream, including epoch and sequence metadata for handling concurrent control sessions and detecting stale frames. The agent should open this stream before setting the task status to `STATUS_EXECUTING` to ensure it is ready to receive control input as soon as the operator begins sending frames. The stream terminates when the task reaches a terminal state, either `STATUS_DONE_OK` or `STATUS_DONE_NOT_OK`.
Was this page helpful?
Previous

StreamTasks

Next

Establishes a server streaming connection for receiving manual control frames for a specific task.

Agents call this RPC to subscribe to manual control frames for a task they are executing. Task Manager forwards frames from the operator’s SendManualControlFrames stream, including epoch and sequence metadata for handling concurrent control sessions and detecting stale frames.

The agent should open this stream before setting the task status to STATUS_EXECUTING to ensure it is ready to receive control input as soon as the operator begins sending frames.

The stream terminates when the task reaches a terminal state, either STATUS_DONE_OK or STATUS_DONE_NOT_OK.

ListenForManualControlFramesRequest

Request
This endpoint expects an object.
task_idstring
The task ID of the manual control task the agent listens for.

ListenForManualControlFramesResponse

Stream response
This endpoint returns an object.
frameobject
The manual control frame. Contains the control instructions and sequencing metadata.