Create SMS AI Agent
curl --request POST \
--url https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"model": "<string>",
"api_keys": [
{
"api_key_id": 123,
"type": "<string>"
}
],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"sms_type": "<string>",
"phone_number": "<string>",
"kb_id": "<string>",
"action_ids": [
{}
],
"additional_settings": {
"additional_settings.idle_time": 123,
"additional_settings.max_messages": 123
}
}
'import requests
url = "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants"
payload = {
"name": "<string>",
"type": "<string>",
"model": "<string>",
"api_keys": [
{
"api_key_id": 123,
"type": "<string>"
}
],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"sms_type": "<string>",
"phone_number": "<string>",
"kb_id": "<string>",
"action_ids": [{}],
"additional_settings": {
"additional_settings.idle_time": 123,
"additional_settings.max_messages": 123
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: '<string>',
model: '<string>',
api_keys: [{api_key_id: 123, type: '<string>'}],
instructions: '<string>',
prompts: {agent: '<string>', goal: '<string>'},
sms_type: '<string>',
phone_number: '<string>',
kb_id: '<string>',
action_ids: [{}],
additional_settings: {'additional_settings.idle_time': 123, 'additional_settings.max_messages': 123}
})
};
fetch('https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'type' => '<string>',
'model' => '<string>',
'api_keys' => [
[
'api_key_id' => 123,
'type' => '<string>'
]
],
'instructions' => '<string>',
'prompts' => [
'agent' => '<string>',
'goal' => '<string>'
],
'sms_type' => '<string>',
'phone_number' => '<string>',
'kb_id' => '<string>',
'action_ids' => [
[
]
],
'additional_settings' => [
'additional_settings.idle_time' => 123,
'additional_settings.max_messages' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"model\": \"<string>\",\n \"api_keys\": [\n {\n \"api_key_id\": 123,\n \"type\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"sms_type\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"kb_id\": \"<string>\",\n \"action_ids\": [\n {}\n ],\n \"additional_settings\": {\n \"additional_settings.idle_time\": 123,\n \"additional_settings.max_messages\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"model\": \"<string>\",\n \"api_keys\": [\n {\n \"api_key_id\": 123,\n \"type\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"sms_type\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"kb_id\": \"<string>\",\n \"action_ids\": [\n {}\n ],\n \"additional_settings\": {\n \"additional_settings.idle_time\": 123,\n \"additional_settings.max_messages\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"model\": \"<string>\",\n \"api_keys\": [\n {\n \"api_key_id\": 123,\n \"type\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"sms_type\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"kb_id\": \"<string>\",\n \"action_ids\": [\n {}\n ],\n \"additional_settings\": {\n \"additional_settings.idle_time\": 123,\n \"additional_settings.max_messages\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"ctx_id": "<string>",
"data": {
"assistant_id": "<string>",
"name": "<string>"
}
}Create-Assistants
Create SMS AI Agent
Create SMS-based AI assistants for text messaging automation and recruiter workflows.
POST
/
v2
/
_new_assistants
Create SMS AI Agent
curl --request POST \
--url https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"type": "<string>",
"model": "<string>",
"api_keys": [
{
"api_key_id": 123,
"type": "<string>"
}
],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"sms_type": "<string>",
"phone_number": "<string>",
"kb_id": "<string>",
"action_ids": [
{}
],
"additional_settings": {
"additional_settings.idle_time": 123,
"additional_settings.max_messages": 123
}
}
'import requests
url = "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants"
payload = {
"name": "<string>",
"type": "<string>",
"model": "<string>",
"api_keys": [
{
"api_key_id": 123,
"type": "<string>"
}
],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"sms_type": "<string>",
"phone_number": "<string>",
"kb_id": "<string>",
"action_ids": [{}],
"additional_settings": {
"additional_settings.idle_time": 123,
"additional_settings.max_messages": 123
}
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
type: '<string>',
model: '<string>',
api_keys: [{api_key_id: 123, type: '<string>'}],
instructions: '<string>',
prompts: {agent: '<string>', goal: '<string>'},
sms_type: '<string>',
phone_number: '<string>',
kb_id: '<string>',
action_ids: [{}],
additional_settings: {'additional_settings.idle_time': 123, 'additional_settings.max_messages': 123}
})
};
fetch('https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'type' => '<string>',
'model' => '<string>',
'api_keys' => [
[
'api_key_id' => 123,
'type' => '<string>'
]
],
'instructions' => '<string>',
'prompts' => [
'agent' => '<string>',
'goal' => '<string>'
],
'sms_type' => '<string>',
'phone_number' => '<string>',
'kb_id' => '<string>',
'action_ids' => [
[
]
],
'additional_settings' => [
'additional_settings.idle_time' => 123,
'additional_settings.max_messages' => 123
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"model\": \"<string>\",\n \"api_keys\": [\n {\n \"api_key_id\": 123,\n \"type\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"sms_type\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"kb_id\": \"<string>\",\n \"action_ids\": [\n {}\n ],\n \"additional_settings\": {\n \"additional_settings.idle_time\": 123,\n \"additional_settings.max_messages\": 123\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"model\": \"<string>\",\n \"api_keys\": [\n {\n \"api_key_id\": 123,\n \"type\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"sms_type\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"kb_id\": \"<string>\",\n \"action_ids\": [\n {}\n ],\n \"additional_settings\": {\n \"additional_settings.idle_time\": 123,\n \"additional_settings.max_messages\": 123\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"model\": \"<string>\",\n \"api_keys\": [\n {\n \"api_key_id\": 123,\n \"type\": \"<string>\"\n }\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"sms_type\": \"<string>\",\n \"phone_number\": \"<string>\",\n \"kb_id\": \"<string>\",\n \"action_ids\": [\n {}\n ],\n \"additional_settings\": {\n \"additional_settings.idle_time\": 123,\n \"additional_settings.max_messages\": 123\n }\n}"
response = http.request(request)
puts response.read_body{
"ctx_id": "<string>",
"data": {
"assistant_id": "<string>",
"name": "<string>"
}
}Authorizations
Enter your ContactSwing JWT Bearer token.
Force recreate (overwrite existing). Example:
trueRequest Body
Assistant display name. Example:
"My SMS Assistant"Assistant type:
"SMS"LLM model:
"cw-llm-1"Detailed recruiter instructions and candidate profiles
SMS-Specific Settings
SMS direction:
"OUTBOUND"Assigned phone number. Example:
"+13465507166"Knowledge base ID
Linked action IDs
[]Response
201 Created - SMS assistant created successfullyRequest context ID
⌘I

