Sign in

v1

latestOpenAPI 3.0.32026-07-1751720.0 KB

Post message

Send a message to the agent. For messages of type 'user', the agent's status must be 'stable' for the operation to complete successfully. Otherwise, this endpoint will return an error.

post/message

Request body

$schemastring uri

A URL to the JSON Schema for this object.

contentstring required

Message content

type'raw' | 'user' required

Example request

{
  "$schema": "https://example.com/schemas/MessageRequestBody.json",
  "content": "Hello, agent!",
  "type": "user"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

okboolean required

Indicates whether the message was sent successfully. For messages of type 'user', success means detecting that the agent began executing the task described. For messages of type 'raw', success means the keystrokes were sent to the terminal.

Example response

{
  "$schema": "https://example.com/schemas/MessageResponseBody.json"
}