v1

latestOpenAPI 3.1.0raw.githubusercontent.com2026-06-304917042.1 MB

sms

Send an outbound SMS (queued; delivered asynchronously)

post/v1/sms/send

Request body

from_numberstring required

Sender E.164

tostring required

Recipient E.164

bodystring required

agent_idstring uuid required

Authorized agent for outbound sends.

context_variablesobject nullable

Optional seed values for the agent's typed context variables, applied once at session bootstrap. Each key must be a variable declared on the agent or one of its bound workflows; values are coerced to the variable's type/enum (unknown key or uncoercible value → 422). System vars are frozen on-file; derived seeds satisfy the collection gate.

media_urlsstring[]

idempotency_keystring nullable

Alphanumeric + dash/underscore, 1-120 chars. Used as the Celery task id so repeat POSTs with the same key are deduped.

Response

Successful Response

session_idstring uuid required

end_user_idstring uuid required

idempotency_keystring nullable required