Skip to main content
POST
Create SMS AI Agent

Authorizations

string
required
Enter your ContactSwing JWT Bearer token.
boolean
Force recreate (overwrite existing). Example: true

Request Body

string
required
Assistant display name. Example: "My SMS Assistant"
string
required
Assistant type: "SMS"
string
required
LLM model: "cw-llm-1"
array
required
SMS API configuration [{"api_key_id":134,"type":"SMS"}]
number
API key ID
string
Key type: SMS
string
required
Detailed recruiter instructions and candidate profiles
object
Agent prompts with agent and goal
string
string

SMS-Specific Settings

string
required
SMS direction: "OUTBOUND"
string
Assigned phone number. Example: "+13465507166"
string
Knowledge base ID
array
Linked action IDs []
object
integer
Idle timeout in seconds. Example: 86400
integer
Maximum messages per conversation. Example: 10

Response

201 Created - SMS assistant created successfully
string
Request context ID
object
string
New assistant ID
string
Assistant name
400 Bad Request - Invalid SMS configuration or missing API keys 401 Unauthorized - Invalid token