Create Chat 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": [
"<string>"
],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"kb_id": "<string>",
"additional_settings": {
"ChatbotCustomization": {
"brandName": "<string>",
"logoUrl": "<string>",
"greetingText": "<string>",
"tagline": "<string>",
"initialMessage": "<string>",
"finalCloseMessage": "<string>",
"checkInMessage": "<string>"
}
},
"action_ids": [
{}
]
}
'import requests
url = "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants"
payload = {
"name": "<string>",
"type": "<string>",
"model": "<string>",
"api_keys": ["<string>"],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"kb_id": "<string>",
"additional_settings": { "ChatbotCustomization": {
"brandName": "<string>",
"logoUrl": "<string>",
"greetingText": "<string>",
"tagline": "<string>",
"initialMessage": "<string>",
"finalCloseMessage": "<string>",
"checkInMessage": "<string>"
} },
"action_ids": [{}]
}
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: ['<string>'],
instructions: '<string>',
prompts: {agent: '<string>', goal: '<string>'},
kb_id: '<string>',
additional_settings: {
ChatbotCustomization: {
brandName: '<string>',
logoUrl: '<string>',
greetingText: '<string>',
tagline: '<string>',
initialMessage: '<string>',
finalCloseMessage: '<string>',
checkInMessage: '<string>'
}
},
action_ids: [{}]
})
};
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' => [
'<string>'
],
'instructions' => '<string>',
'prompts' => [
'agent' => '<string>',
'goal' => '<string>'
],
'kb_id' => '<string>',
'additional_settings' => [
'ChatbotCustomization' => [
'brandName' => '<string>',
'logoUrl' => '<string>',
'greetingText' => '<string>',
'tagline' => '<string>',
'initialMessage' => '<string>',
'finalCloseMessage' => '<string>',
'checkInMessage' => '<string>'
]
],
'action_ids' => [
[
]
]
]),
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 \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"kb_id\": \"<string>\",\n \"additional_settings\": {\n \"ChatbotCustomization\": {\n \"brandName\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"greetingText\": \"<string>\",\n \"tagline\": \"<string>\",\n \"initialMessage\": \"<string>\",\n \"finalCloseMessage\": \"<string>\",\n \"checkInMessage\": \"<string>\"\n }\n },\n \"action_ids\": [\n {}\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 \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"kb_id\": \"<string>\",\n \"additional_settings\": {\n \"ChatbotCustomization\": {\n \"brandName\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"greetingText\": \"<string>\",\n \"tagline\": \"<string>\",\n \"initialMessage\": \"<string>\",\n \"finalCloseMessage\": \"<string>\",\n \"checkInMessage\": \"<string>\"\n }\n },\n \"action_ids\": [\n {}\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 \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"kb_id\": \"<string>\",\n \"additional_settings\": {\n \"ChatbotCustomization\": {\n \"brandName\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"greetingText\": \"<string>\",\n \"tagline\": \"<string>\",\n \"initialMessage\": \"<string>\",\n \"finalCloseMessage\": \"<string>\",\n \"checkInMessage\": \"<string>\"\n }\n },\n \"action_ids\": [\n {}\n ]\n}"
response = http.request(request)
puts response.read_body{
"ctx_id": "<string>",
"data": {
"assistant_id": "<string>",
"name": "<string>"
}
}Create-Assistants
Create Chat AI Agent
Create web chat-based AI assistants for website integration and customer support.
POST
/
v2
/
_new_assistants
Create Chat 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": [
"<string>"
],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"kb_id": "<string>",
"additional_settings": {
"ChatbotCustomization": {
"brandName": "<string>",
"logoUrl": "<string>",
"greetingText": "<string>",
"tagline": "<string>",
"initialMessage": "<string>",
"finalCloseMessage": "<string>",
"checkInMessage": "<string>"
}
},
"action_ids": [
{}
]
}
'import requests
url = "https://prod-contactswing-fastapi-962560522883.us-central1.run.app/v2/_new_assistants"
payload = {
"name": "<string>",
"type": "<string>",
"model": "<string>",
"api_keys": ["<string>"],
"instructions": "<string>",
"prompts": {
"agent": "<string>",
"goal": "<string>"
},
"kb_id": "<string>",
"additional_settings": { "ChatbotCustomization": {
"brandName": "<string>",
"logoUrl": "<string>",
"greetingText": "<string>",
"tagline": "<string>",
"initialMessage": "<string>",
"finalCloseMessage": "<string>",
"checkInMessage": "<string>"
} },
"action_ids": [{}]
}
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: ['<string>'],
instructions: '<string>',
prompts: {agent: '<string>', goal: '<string>'},
kb_id: '<string>',
additional_settings: {
ChatbotCustomization: {
brandName: '<string>',
logoUrl: '<string>',
greetingText: '<string>',
tagline: '<string>',
initialMessage: '<string>',
finalCloseMessage: '<string>',
checkInMessage: '<string>'
}
},
action_ids: [{}]
})
};
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' => [
'<string>'
],
'instructions' => '<string>',
'prompts' => [
'agent' => '<string>',
'goal' => '<string>'
],
'kb_id' => '<string>',
'additional_settings' => [
'ChatbotCustomization' => [
'brandName' => '<string>',
'logoUrl' => '<string>',
'greetingText' => '<string>',
'tagline' => '<string>',
'initialMessage' => '<string>',
'finalCloseMessage' => '<string>',
'checkInMessage' => '<string>'
]
],
'action_ids' => [
[
]
]
]),
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 \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"kb_id\": \"<string>\",\n \"additional_settings\": {\n \"ChatbotCustomization\": {\n \"brandName\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"greetingText\": \"<string>\",\n \"tagline\": \"<string>\",\n \"initialMessage\": \"<string>\",\n \"finalCloseMessage\": \"<string>\",\n \"checkInMessage\": \"<string>\"\n }\n },\n \"action_ids\": [\n {}\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 \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"kb_id\": \"<string>\",\n \"additional_settings\": {\n \"ChatbotCustomization\": {\n \"brandName\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"greetingText\": \"<string>\",\n \"tagline\": \"<string>\",\n \"initialMessage\": \"<string>\",\n \"finalCloseMessage\": \"<string>\",\n \"checkInMessage\": \"<string>\"\n }\n },\n \"action_ids\": [\n {}\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 \"<string>\"\n ],\n \"instructions\": \"<string>\",\n \"prompts\": {\n \"agent\": \"<string>\",\n \"goal\": \"<string>\"\n },\n \"kb_id\": \"<string>\",\n \"additional_settings\": {\n \"ChatbotCustomization\": {\n \"brandName\": \"<string>\",\n \"logoUrl\": \"<string>\",\n \"greetingText\": \"<string>\",\n \"tagline\": \"<string>\",\n \"initialMessage\": \"<string>\",\n \"finalCloseMessage\": \"<string>\",\n \"checkInMessage\": \"<string>\"\n }\n },\n \"action_ids\": [\n {}\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.
Request Body
Assistant display name. Example:
"My Chat Assistant"Assistant type:
"CHAT"LLM model:
"cw-llm-1"API key configuration
[]Detailed agent instructions and restaurant ordering guidelines
Knowledge base ID
Chat Customization
Brand name. Example:
"ContactSwing AI"Brand name. Example:
"ContactSwing AI"Brand name. Example:
"ContactSwing AI"Logo URL
Welcome message. Example:
"Hello welcome back"Tagline. Example:
"Contactswing"First message. Example:
"Hi, I'm Ashley 👋 Welcome to ContactSwing AI!"Example:
Just checking in — are you still there?Linked action IDs
[]Response
201 Created - Chat assistant created successfullyRequest context ID
⌘I

