Skip to main content
POST
Send Message To Conversation

Authorizations

X-Access-Token
string
header
required

Path Parameters

conversation_id
string<uuid>
required

Body

application/json

Request to send a follow-up message to a conversation.

This is used to send messages to an existing conversation via REST API, as an alternative to WebSocket communication.

content
(TextContent · object | ImageContent · object)[]
required

The message content as a list of text and/or image content blocks.

Minimum array length: 1
role
string
default:user

The role of the message sender. Currently only "user" is supported.

Allowed value: "user"
run
boolean
default:true

Whether to automatically run the agent after sending the message.

Response

Successful Response

Response from sending a message to a conversation.

success
boolean
required

Whether the message was successfully sent to the agent.

sandbox_status
enum<string>
required

The current status of the sandbox after the operation.

Available options:
STARTING,
RUNNING,
PAUSED,
ERROR,
MISSING
message
string | null

Optional message with additional details (e.g., if sandbox was resumed).