Skip to main content
POST
Start a public Agent conversation

Headers

Idempotency-Key
string

Optional 8–120 character key for replayable mutations. Send the exact same method, URI, and body on retries; receipts expire after 24 hours.

Required string length: 8 - 120
X-ContactButton-Protocol
enum<string>

Set to rest for direct REST callers. Hosted and embedded ContactButton chat omit this header and are attributed to web.

Available options:
rest

Path Parameters

agent
string<uuid>
required

Body

application/json

Supply message or a current suggested_reply_id. Contact details and privacy consent are required according to the returned chat_policy. source_url is retained only when enabled by the owner.

message
string
required
Required string length: 1 - 10000
suggested_reply_id
string<uuid> | null
visitor_name
string | null
Maximum string length: 255
visitor_email
string<email> | null
Maximum string length: 255
visitor_phone
string | null
Maximum string length: 40
phone_country
string | null
Maximum string length: 4
source_url
string | null
Maximum string length: 2048
button
string<uuid> | null
app
string<uuid> | null

Response

Successful data envelope containing the common hosted web, REST, MCP, and A2A handoff state.

data
object
required
meta
object
required