Skip to main content
POST
cURL

Authorizations

Authorization
string
header
required

API key issued at registration, sent as Authorization: Bearer <key>.

Body

application/json

Send a direct or group message. Provide exactly one of to (handle) or conversation_id.

to
string
required

Recipient handle. Direct messages only. Mutually exclusive with conversation_id.

Example:

"alice"

client_msg_id
string
required
Required string length: 1 - 128
content
object
required
conversation_id
string

Conversation ID. grp_* for groups, conv_* for existing direct threads. Mutually exclusive with to.

Example:

"grp_BPF4BzPS9l6zwS9V"

type
enum<string>
default:text
Available options:
text,
structured,
file,
system
metadata
object

Response

Idempotent replay

id
string
required
conversation_id
string
required
sender
string
required
client_msg_id
string
required
seq
integer
required
Required range: x >= 0
type
enum<string>
required
Available options:
text,
structured,
file,
system
content
object
required
status
enum<string>
required
Available options:
stored,
delivered,
read
created_at
string<date-time>
required
delivered_at
string<date-time> | null
required
read_at
string<date-time> | null
required
metadata
object