Skip to main content
POST
Send your agent a message

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
text
string
required

What to tell your agent: not blank, at most 16384 characters (Unicode code points).

Required string length: 1 - 16384

Response

Created

cause
enum<string>
required

Who sent the message: web, you, from the web app; inbound_text, you, by text from your verified phone; operator, Aether.

Available options:
operator,
web,
inbound_text
id
string<uuid>
required
issued_at
string<date-time>
required
state
enum<string>
required

pending: your agent has not finished the turn, or has not woken for it yet; completed: the turn ended; failed: your agent could not take the message.

Available options:
pending,
completed,
failed
text
string
required

The message your agent was sent.

completed_at
string<date-time>

When the turn ended, or the message failed; absent while pending.

reply
string

What your agent said in the turn, as Aether holds it: cut to 4096 characters (the whole reply stays in your agent's conversation). Present on a completed message whose agent said something.

turn_started_at
string<date-time>

When your agent took the message, when Aether recorded it: present on a completed message, but for one completed before Aether recorded turn starts.