Skip to main content
POST
Post a chat message to a fleet

Authorizations

Authorization
string
header
required

Send a dashboard session token, an account API key (agt_t), or a command-line credential (afc_) as a Bearer token. Each endpoint lists accepted credential types.

Path Parameters

workspace_id
string
required

Workspace identifier (version 7 universally unique identifier, or UUID).

fleet_id
string
required

Fleet identifier (version 7 universally unique identifier, or UUID).

Body

application/json

POST /v1/workspaces/{ws}/fleets/{id}/messages — an operator's steer.

Unknown fields are refused with 400. A field this endpoint does not read is a typo, or a feature it lacks. Ignoring it would let a client believe a setting took effect.

message
string
required

What to say to the fleet: 1 to 8192 bytes, with no NUL character.

Bounded on the decoded bytes, which is what reaches the stream. The escaped form a client sends is not what counts against the limit.

operation_id
string | null

Your retry identifier, 1 to 200 bytes with no NUL character (U+0000).

Reuse it with the same message and sender for one run and charge. Reuse with different text or sender returns 409 UZ-AGT-016. Each person is one sender; workspace API keys share one sender. Omit it to create a new message on every request. Safe retries remain valid after stopping or pausing the fleet.

Response

Accepted for publication; delivery to subscribers is not yet confirmed

What a steer returns once agentsfleet accepts the request.

The response carries the id the run is found under. Filter the live event tail on event_id to follow the message you just sent.

event_id
string
required

The canonical event id the steer became.

replayed
boolean
required

Whether an earlier send of the same operation_id already admitted this message. When true, event_id is that send's event, which may have run already. false when this call admitted it.

status
string
required

Always accepted.