Sign in

v52

latestOpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB
Assistants

Assistant Sms Chat

Send an SMS message for an assistant. This endpoint:

  1. Validates the assistant exists and has messaging profile configured
  2. If should_create_conversation is true, creates a new conversation with metadata
  3. Sends the SMS message (If text is set, this will be sent. Otherwise, if this is the first message in the conversation and the assistant has a greeting configured, this will be sent. Otherwise the assistant will generate the text to send.)
  4. Updates conversation metadata if provided
  5. Returns the conversation ID
post/ai/assistants/{assistant_id}/chat/sms

Path parameters

assistant_idstring required

Unique identifier of the assistant.

Request body

conversation_metadataobject
fromstring required
should_create_conversationboolean
textstring
tostring required

Response

Successful Response

conversation_idstring