Skip to main content
POST
Start a Quick AI Text conversation

Authorizations

Authorization
string
header
required

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

Headers

Idempotency-Key
string

A UUID. When present, deduplicates repeat submissions. See /api-reference/idempotency.

Body

application/json
to_numbers
string[]
required

Who to reach: phone numbers in any common format (415-555-0123, (415) 555-0123, +14155550123; +1 is assumed when the country code is missing) and/or names of contacts in the workspace (case-insensitive, small typos are fine). Each entry is detected automatically

Required array length: 1 - 20 elements

Phone number in any common format (+1 assumed when missing) or a contact's name

Required string length: 1 - 120
goal
string
required

What the AI should accomplish over the thread. Drives the system prompt.

Required string length: 10 - 2000
language
string
default:en
required
Maximum string length: 10
max_messages
integer
default:15
required

Most messages the AI sends on each thread, opener included, before it ends the conversation (default 15, max 20). The recipient's replies do not count toward it

Required range: 1 <= x <= 20
reply_delay_seconds
integer
default:0
required
Required range: 0 <= x <= 300
conversation_timeout_hours
integer
default:48
required
Required range: 1 <= x <= 168
first_message
string
Required string length: 1 - 1200
instructions
string
Maximum string length: 4000
contact_name
string
Maximum string length: 120

Response

Success

data
object
required