Skip to main content
POST
Send message

Authorizations

Authorization
string
header
required

Organization or personal API key from Settings → API Keys.

Headers

X-Replicas-Api-Version
enum<string>

API version. 2026-10-07 returns snake_case responses. See versioning.

Available options:
2026-10-07

Path Parameters

id
string<uuid>
required

The unique identifier of the replica

Body

application/json

Request body for sending a message to a workspace

message
string
required

Message to send to the coding agent

coding_agent
enum<string>

Coding agent to use. With chat_id, naming another agent than the chat's continues that chat on it, with the conversation handed over.

Available options:
claude,
codex,
cursor,
gemini,
muse,
opencode,
pi
chat_id
string

Target a specific chat session

model
string

Model ID. Defaults to the organization default for the coding agent.

images
object[]

Images to attach to the message

goal_mode
boolean

Whether to set the message as the active goal (Claude Code and Codex). Leading /goal in the message is also detected and stripped.

fast_mode
boolean

Whether to run in fast mode. Leading /fast in the message is also detected and stripped.

thinking_level
enum<string>

Reasoning effort. ultra is for Codex and Muse Code; ultracode is for Claude Code. Defaults to the agent's default.

Available options:
low,
medium,
high,
xhigh,
max,
ultra,
ultracode
expect_reply
boolean

When a workspace sends the message, the final response of the turn it starts comes back to the sending chat as a replied event. false skips that. Defaults to true.

sender_email
string

Email of the user sending this message. When the request is authenticated via dashboard auth, the server overrides this with the authenticated user's email.

Response

Message accepted

Response after sending a message to a workspace

status
enum<string>
required

Status of the message delivery

Available options:
sent,
queued,
waking
message_id
string | null
required

Unique identifier for the sent message

position
integer | null
required

Queue position if status is 'queued'

chat_id
string | null
required

ID of the chat the message was sent to