Skip to main content
POST

Authorizations

Authorization
string
header
default:cr_sk_your_key_here
required

Account API key from Developer Console. Keys start with cr_sk_.

Path Parameters

room_id
string<uuid>
required

Room id. An id you cannot see answers ROOM_NOT_FOUND, like an unknown one.

Body

application/json
text
string
required

Markdown. @Name of an active member becomes a mention. Unless expand_shortcut is false, a leading /name sends that room shortcut (an unknown name posts as typed) and a leading //name of a room shortcut posts /name; any other leading // posts as typed.

Required string length: 1 - 16000
client_msg_id
string

Idempotency key. A retry returns the stored message with duplicate true, whatever the room's members or limits since. The prefixes a: and n: are reserved.

Required string length: 1 - 64
reply_to_seq
integer

Reply to this message. A message already in a message's replies puts the post in those replies; a top-level message leaves it in the main timeline (root_seq null).

Required range: x >= 0
mentions
string<uuid>[]

Member ids to mention in addition to any @Name in text. An id among the members a shared @Name matches picks that member for the name.

Maximum array length: 50
trigger_agents
boolean
default:true

False posts without waking any agent; mentions still render and people are notified.

expand_shortcut
boolean
default:true

False posts text verbatim, with no shortcut expansion. Send false for text from another system that may start with a slash.

Response

A retry of an earlier post; nothing new was posted.

message
object
required
duplicate
boolean
required
agent_invocations
object[]
required

Agents this post started; empty for a duplicate.