Sign in
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.

Headers

Idempotency-Keystring

Optional opaque, unquoted key for safely retrying the same logical request. Keys must contain 1 to 255 letters, numbers, hyphens, or underscores. Generate a unique UUID v4 for each operation and reuse it only when retrying that operation with the same request. Invalid headers—including duplicate, empty, malformed, or overlong values—return 400 with error code 10015. A request already in progress with the same key returns 409; reusing the key with a different request returns 422. Only successful responses are replayed, for up to 24 hours. Do not include sensitive data in the key.

Request body

fromstring required
tostring required
textstring
conversation_metadataobject
should_create_conversationboolean

Response

Successful Response

conversation_idstring

Changes