Create a new agent
curl --request POST \
--url https://prod.featherhq.com/api/v1/agents \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"voicemailMessage": "<string>",
"overrideSTTConfig": {
"keywords": [
{
"keyword": "<string>",
"intensifier": "INTENSIFY"
}
]
},
"templateId": "<string>",
"agentType": "CALL",
"useKnowledgeBase": true,
"prompt": {
"system": "<string>",
"systemUIFormatting": null,
"variables": [
{
"name": "<string>",
"required": true,
"defaultValue": "<string>"
}
],
"tools": [
"<string>"
],
"preBuiltTools": [
"<string>"
]
},
"promptPersonalityId": "<string>",
"llmConfigId": "<string>",
"languageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sttConfigId": "<string>",
"ttsConfigId": "<string>",
"voiceId": "<string>",
"enableBackgroundAudio": false,
"backgroundAudio": 50,
"voiceVolume": 100,
"voiceSpeed": 1,
"agentDelayBeforeFirstMessage": 500,
"initialSilenceTimeout": 30000,
"finalSilenceTimeout": 10000,
"transferImmediatelyOnInbound": false,
"maxCallDuration": 900,
"voicemailDetectionMode": "ASYNC",
"minInterruptionWords": 1,
"minInterruptionDuration": 1,
"minEndpointingDelay": 0.5,
"maxEndpointingDelay": 3,
"vadActivationThreshold": 0.5,
"sms": {
"inactivityTimeoutHours": 2,
"smsMaxTokens": 500,
"smsTemperature": 0.7,
"discardInboundSms": false
},
"webChatAggregationWindowSeconds": 58,
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2,
"warmTransferBriefingTemplate": "<string>",
"warmTransferInteractive": true,
"warmTransferInstructions": "<string>"
}
'import requests
url = "https://prod.featherhq.com/api/v1/agents"
payload = {
"name": "<string>",
"description": "<string>",
"voicemailMessage": "<string>",
"overrideSTTConfig": { "keywords": [
{
"keyword": "<string>",
"intensifier": "INTENSIFY"
}
] },
"templateId": "<string>",
"agentType": "CALL",
"useKnowledgeBase": True,
"prompt": {
"system": "<string>",
"systemUIFormatting": None,
"variables": [
{
"name": "<string>",
"required": True,
"defaultValue": "<string>"
}
],
"tools": ["<string>"],
"preBuiltTools": ["<string>"]
},
"promptPersonalityId": "<string>",
"llmConfigId": "<string>",
"languageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sttConfigId": "<string>",
"ttsConfigId": "<string>",
"voiceId": "<string>",
"enableBackgroundAudio": False,
"backgroundAudio": 50,
"voiceVolume": 100,
"voiceSpeed": 1,
"agentDelayBeforeFirstMessage": 500,
"initialSilenceTimeout": 30000,
"finalSilenceTimeout": 10000,
"transferImmediatelyOnInbound": False,
"maxCallDuration": 900,
"voicemailDetectionMode": "ASYNC",
"minInterruptionWords": 1,
"minInterruptionDuration": 1,
"minEndpointingDelay": 0.5,
"maxEndpointingDelay": 3,
"vadActivationThreshold": 0.5,
"sms": {
"inactivityTimeoutHours": 2,
"smsMaxTokens": 500,
"smsTemperature": 0.7,
"discardInboundSms": False
},
"webChatAggregationWindowSeconds": 58,
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2,
"warmTransferBriefingTemplate": "<string>",
"warmTransferInteractive": True,
"warmTransferInstructions": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
voicemailMessage: '<string>',
overrideSTTConfig: {keywords: [{keyword: '<string>', intensifier: 'INTENSIFY'}]},
templateId: '<string>',
agentType: 'CALL',
useKnowledgeBase: true,
prompt: {
system: '<string>',
systemUIFormatting: null,
variables: [{name: '<string>', required: true, defaultValue: '<string>'}],
tools: ['<string>'],
preBuiltTools: ['<string>']
},
promptPersonalityId: '<string>',
llmConfigId: '<string>',
languageId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sttConfigId: '<string>',
ttsConfigId: '<string>',
voiceId: '<string>',
enableBackgroundAudio: false,
backgroundAudio: 50,
voiceVolume: 100,
voiceSpeed: 1,
agentDelayBeforeFirstMessage: 500,
initialSilenceTimeout: 30000,
finalSilenceTimeout: 10000,
transferImmediatelyOnInbound: false,
maxCallDuration: 900,
voicemailDetectionMode: 'ASYNC',
minInterruptionWords: 1,
minInterruptionDuration: 1,
minEndpointingDelay: 0.5,
maxEndpointingDelay: 3,
vadActivationThreshold: 0.5,
sms: {
inactivityTimeoutHours: 2,
smsMaxTokens: 500,
smsTemperature: 0.7,
discardInboundSms: false
},
webChatAggregationWindowSeconds: 58,
emailDomainId: '<string>',
emailFromLocalPart: '<string>',
emailFromName: '<string>',
emailMaxTokens: 5050,
emailTemperature: 1,
emailInactivityTimeoutHours: 2,
warmTransferBriefingTemplate: '<string>',
warmTransferInteractive: true,
warmTransferInstructions: '<string>'
})
};
fetch('https://prod.featherhq.com/api/v1/agents', 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.featherhq.com/api/v1/agents",
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>',
'description' => '<string>',
'voicemailMessage' => '<string>',
'overrideSTTConfig' => [
'keywords' => [
[
'keyword' => '<string>',
'intensifier' => 'INTENSIFY'
]
]
],
'templateId' => '<string>',
'agentType' => 'CALL',
'useKnowledgeBase' => true,
'prompt' => [
'system' => '<string>',
'systemUIFormatting' => null,
'variables' => [
[
'name' => '<string>',
'required' => true,
'defaultValue' => '<string>'
]
],
'tools' => [
'<string>'
],
'preBuiltTools' => [
'<string>'
]
],
'promptPersonalityId' => '<string>',
'llmConfigId' => '<string>',
'languageId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sttConfigId' => '<string>',
'ttsConfigId' => '<string>',
'voiceId' => '<string>',
'enableBackgroundAudio' => false,
'backgroundAudio' => 50,
'voiceVolume' => 100,
'voiceSpeed' => 1,
'agentDelayBeforeFirstMessage' => 500,
'initialSilenceTimeout' => 30000,
'finalSilenceTimeout' => 10000,
'transferImmediatelyOnInbound' => false,
'maxCallDuration' => 900,
'voicemailDetectionMode' => 'ASYNC',
'minInterruptionWords' => 1,
'minInterruptionDuration' => 1,
'minEndpointingDelay' => 0.5,
'maxEndpointingDelay' => 3,
'vadActivationThreshold' => 0.5,
'sms' => [
'inactivityTimeoutHours' => 2,
'smsMaxTokens' => 500,
'smsTemperature' => 0.7,
'discardInboundSms' => false
],
'webChatAggregationWindowSeconds' => 58,
'emailDomainId' => '<string>',
'emailFromLocalPart' => '<string>',
'emailFromName' => '<string>',
'emailMaxTokens' => 5050,
'emailTemperature' => 1,
'emailInactivityTimeoutHours' => 2,
'warmTransferBriefingTemplate' => '<string>',
'warmTransferInteractive' => true,
'warmTransferInstructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.featherhq.com/api/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"voicemailMessage\": \"<string>\",\n \"overrideSTTConfig\": {\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": \"INTENSIFY\"\n }\n ]\n },\n \"templateId\": \"<string>\",\n \"agentType\": \"CALL\",\n \"useKnowledgeBase\": true,\n \"prompt\": {\n \"system\": \"<string>\",\n \"systemUIFormatting\": null,\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"preBuiltTools\": [\n \"<string>\"\n ]\n },\n \"promptPersonalityId\": \"<string>\",\n \"llmConfigId\": \"<string>\",\n \"languageId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sttConfigId\": \"<string>\",\n \"ttsConfigId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"enableBackgroundAudio\": false,\n \"backgroundAudio\": 50,\n \"voiceVolume\": 100,\n \"voiceSpeed\": 1,\n \"agentDelayBeforeFirstMessage\": 500,\n \"initialSilenceTimeout\": 30000,\n \"finalSilenceTimeout\": 10000,\n \"transferImmediatelyOnInbound\": false,\n \"maxCallDuration\": 900,\n \"voicemailDetectionMode\": \"ASYNC\",\n \"minInterruptionWords\": 1,\n \"minInterruptionDuration\": 1,\n \"minEndpointingDelay\": 0.5,\n \"maxEndpointingDelay\": 3,\n \"vadActivationThreshold\": 0.5,\n \"sms\": {\n \"inactivityTimeoutHours\": 2,\n \"smsMaxTokens\": 500,\n \"smsTemperature\": 0.7,\n \"discardInboundSms\": false\n },\n \"webChatAggregationWindowSeconds\": 58,\n \"emailDomainId\": \"<string>\",\n \"emailFromLocalPart\": \"<string>\",\n \"emailFromName\": \"<string>\",\n \"emailMaxTokens\": 5050,\n \"emailTemperature\": 1,\n \"emailInactivityTimeoutHours\": 2,\n \"warmTransferBriefingTemplate\": \"<string>\",\n \"warmTransferInteractive\": true,\n \"warmTransferInstructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.featherhq.com/api/v1/agents")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"voicemailMessage\": \"<string>\",\n \"overrideSTTConfig\": {\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": \"INTENSIFY\"\n }\n ]\n },\n \"templateId\": \"<string>\",\n \"agentType\": \"CALL\",\n \"useKnowledgeBase\": true,\n \"prompt\": {\n \"system\": \"<string>\",\n \"systemUIFormatting\": null,\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"preBuiltTools\": [\n \"<string>\"\n ]\n },\n \"promptPersonalityId\": \"<string>\",\n \"llmConfigId\": \"<string>\",\n \"languageId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sttConfigId\": \"<string>\",\n \"ttsConfigId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"enableBackgroundAudio\": false,\n \"backgroundAudio\": 50,\n \"voiceVolume\": 100,\n \"voiceSpeed\": 1,\n \"agentDelayBeforeFirstMessage\": 500,\n \"initialSilenceTimeout\": 30000,\n \"finalSilenceTimeout\": 10000,\n \"transferImmediatelyOnInbound\": false,\n \"maxCallDuration\": 900,\n \"voicemailDetectionMode\": \"ASYNC\",\n \"minInterruptionWords\": 1,\n \"minInterruptionDuration\": 1,\n \"minEndpointingDelay\": 0.5,\n \"maxEndpointingDelay\": 3,\n \"vadActivationThreshold\": 0.5,\n \"sms\": {\n \"inactivityTimeoutHours\": 2,\n \"smsMaxTokens\": 500,\n \"smsTemperature\": 0.7,\n \"discardInboundSms\": false\n },\n \"webChatAggregationWindowSeconds\": 58,\n \"emailDomainId\": \"<string>\",\n \"emailFromLocalPart\": \"<string>\",\n \"emailFromName\": \"<string>\",\n \"emailMaxTokens\": 5050,\n \"emailTemperature\": 1,\n \"emailInactivityTimeoutHours\": 2,\n \"warmTransferBriefingTemplate\": \"<string>\",\n \"warmTransferInteractive\": true,\n \"warmTransferInstructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"voicemailMessage\": \"<string>\",\n \"overrideSTTConfig\": {\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": \"INTENSIFY\"\n }\n ]\n },\n \"templateId\": \"<string>\",\n \"agentType\": \"CALL\",\n \"useKnowledgeBase\": true,\n \"prompt\": {\n \"system\": \"<string>\",\n \"systemUIFormatting\": null,\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"preBuiltTools\": [\n \"<string>\"\n ]\n },\n \"promptPersonalityId\": \"<string>\",\n \"llmConfigId\": \"<string>\",\n \"languageId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sttConfigId\": \"<string>\",\n \"ttsConfigId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"enableBackgroundAudio\": false,\n \"backgroundAudio\": 50,\n \"voiceVolume\": 100,\n \"voiceSpeed\": 1,\n \"agentDelayBeforeFirstMessage\": 500,\n \"initialSilenceTimeout\": 30000,\n \"finalSilenceTimeout\": 10000,\n \"transferImmediatelyOnInbound\": false,\n \"maxCallDuration\": 900,\n \"voicemailDetectionMode\": \"ASYNC\",\n \"minInterruptionWords\": 1,\n \"minInterruptionDuration\": 1,\n \"minEndpointingDelay\": 0.5,\n \"maxEndpointingDelay\": 3,\n \"vadActivationThreshold\": 0.5,\n \"sms\": {\n \"inactivityTimeoutHours\": 2,\n \"smsMaxTokens\": 500,\n \"smsTemperature\": 0.7,\n \"discardInboundSms\": false\n },\n \"webChatAggregationWindowSeconds\": 58,\n \"emailDomainId\": \"<string>\",\n \"emailFromLocalPart\": \"<string>\",\n \"emailFromName\": \"<string>\",\n \"emailMaxTokens\": 5050,\n \"emailTemperature\": 1,\n \"emailInactivityTimeoutHours\": 2,\n \"warmTransferBriefingTemplate\": \"<string>\",\n \"warmTransferInteractive\": true,\n \"warmTransferInstructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"smsPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"inboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"outboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"version": {
"id": "<string>",
"version": 123,
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"promptPersonalityId": "<string>",
"sttConfigId": "<string>",
"ttsConfigId": "<string>",
"llmConfigId": "<string>",
"overrideSTTConfig": {
"keywords": [
{
"keyword": "<string>",
"intensifier": "INTENSIFY"
}
]
},
"overrideTTSConfig": {
"pronunciations": []
},
"overrideLLMConfig": {},
"voiceId": "<string>",
"postCallPrompt": "<string>",
"postCallVariables": [
{
"variableName": "<string>",
"description": "<string>",
"required": false
}
],
"knowledgeBaseCollectionIds": [
"<string>"
],
"voicemailMessage": "<string>",
"firstMessage": "<string>",
"forwardingPhoneNumber": "<string>",
"warmTransferBriefingTemplate": "<string>",
"warmTransferInstructions": "<string>",
"inactivityTimeoutHours": 2,
"smsMaxTokens": 1050,
"smsTemperature": 1,
"webChatAggregationWindowSeconds": 58,
"prompt": {
"system": "<string>",
"systemUIFormatting": null,
"variables": [
{
"name": "<string>",
"required": true,
"defaultValue": "<string>"
}
],
"tools": [
"<string>"
],
"preBuiltTools": [
"<string>"
]
},
"voicemailDetectionMode": "ASYNC",
"speakFirst": false,
"useKnowledgeBase": true,
"enableBackgroundAudio": false,
"backgroundAudio": 50,
"voiceVolume": 100,
"warmTransferInteractive": false,
"voiceSpeed": 1,
"agentDelayBeforeFirstMessage": 500,
"initialSilenceTimeout": 30000,
"finalSilenceTimeout": 10000,
"maxCallDuration": 900,
"minInterruptionWords": 1,
"minInterruptionDuration": 1,
"minEndpointingDelay": 0.5,
"maxEndpointingDelay": 3,
"vadActivationThreshold": 0.5,
"language": {
"languageId": "<string>",
"languageDisplayName": "<string>"
},
"transferImmediatelyOnInbound": false,
"discardInboundSms": false,
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2,
"emailFilteringEnabled": false,
"emailResponseMode": "AUTO_SEND",
"emailConfidenceThreshold": 0.8,
"emailTags": [
{
"name": "<string>",
"prompt": "<string>",
"autoClose": true,
"gmailLabelId": "<string>",
"gmailLabelName": "<string>"
}
],
"sentimentAnalysis": false,
"preCallWebhook": {
"mode": "tool",
"toolId": "<string>",
"toolSlug": "<string>"
}
},
"callObservabilityEnabled": false
}
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Agents
Create a new agent
Create a new voice or text (SMS) agent
POST
/
api
/
v1
/
agents
Create a new agent
curl --request POST \
--url https://prod.featherhq.com/api/v1/agents \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"voicemailMessage": "<string>",
"overrideSTTConfig": {
"keywords": [
{
"keyword": "<string>",
"intensifier": "INTENSIFY"
}
]
},
"templateId": "<string>",
"agentType": "CALL",
"useKnowledgeBase": true,
"prompt": {
"system": "<string>",
"systemUIFormatting": null,
"variables": [
{
"name": "<string>",
"required": true,
"defaultValue": "<string>"
}
],
"tools": [
"<string>"
],
"preBuiltTools": [
"<string>"
]
},
"promptPersonalityId": "<string>",
"llmConfigId": "<string>",
"languageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sttConfigId": "<string>",
"ttsConfigId": "<string>",
"voiceId": "<string>",
"enableBackgroundAudio": false,
"backgroundAudio": 50,
"voiceVolume": 100,
"voiceSpeed": 1,
"agentDelayBeforeFirstMessage": 500,
"initialSilenceTimeout": 30000,
"finalSilenceTimeout": 10000,
"transferImmediatelyOnInbound": false,
"maxCallDuration": 900,
"voicemailDetectionMode": "ASYNC",
"minInterruptionWords": 1,
"minInterruptionDuration": 1,
"minEndpointingDelay": 0.5,
"maxEndpointingDelay": 3,
"vadActivationThreshold": 0.5,
"sms": {
"inactivityTimeoutHours": 2,
"smsMaxTokens": 500,
"smsTemperature": 0.7,
"discardInboundSms": false
},
"webChatAggregationWindowSeconds": 58,
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2,
"warmTransferBriefingTemplate": "<string>",
"warmTransferInteractive": true,
"warmTransferInstructions": "<string>"
}
'import requests
url = "https://prod.featherhq.com/api/v1/agents"
payload = {
"name": "<string>",
"description": "<string>",
"voicemailMessage": "<string>",
"overrideSTTConfig": { "keywords": [
{
"keyword": "<string>",
"intensifier": "INTENSIFY"
}
] },
"templateId": "<string>",
"agentType": "CALL",
"useKnowledgeBase": True,
"prompt": {
"system": "<string>",
"systemUIFormatting": None,
"variables": [
{
"name": "<string>",
"required": True,
"defaultValue": "<string>"
}
],
"tools": ["<string>"],
"preBuiltTools": ["<string>"]
},
"promptPersonalityId": "<string>",
"llmConfigId": "<string>",
"languageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sttConfigId": "<string>",
"ttsConfigId": "<string>",
"voiceId": "<string>",
"enableBackgroundAudio": False,
"backgroundAudio": 50,
"voiceVolume": 100,
"voiceSpeed": 1,
"agentDelayBeforeFirstMessage": 500,
"initialSilenceTimeout": 30000,
"finalSilenceTimeout": 10000,
"transferImmediatelyOnInbound": False,
"maxCallDuration": 900,
"voicemailDetectionMode": "ASYNC",
"minInterruptionWords": 1,
"minInterruptionDuration": 1,
"minEndpointingDelay": 0.5,
"maxEndpointingDelay": 3,
"vadActivationThreshold": 0.5,
"sms": {
"inactivityTimeoutHours": 2,
"smsMaxTokens": 500,
"smsTemperature": 0.7,
"discardInboundSms": False
},
"webChatAggregationWindowSeconds": 58,
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2,
"warmTransferBriefingTemplate": "<string>",
"warmTransferInteractive": True,
"warmTransferInstructions": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
voicemailMessage: '<string>',
overrideSTTConfig: {keywords: [{keyword: '<string>', intensifier: 'INTENSIFY'}]},
templateId: '<string>',
agentType: 'CALL',
useKnowledgeBase: true,
prompt: {
system: '<string>',
systemUIFormatting: null,
variables: [{name: '<string>', required: true, defaultValue: '<string>'}],
tools: ['<string>'],
preBuiltTools: ['<string>']
},
promptPersonalityId: '<string>',
llmConfigId: '<string>',
languageId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sttConfigId: '<string>',
ttsConfigId: '<string>',
voiceId: '<string>',
enableBackgroundAudio: false,
backgroundAudio: 50,
voiceVolume: 100,
voiceSpeed: 1,
agentDelayBeforeFirstMessage: 500,
initialSilenceTimeout: 30000,
finalSilenceTimeout: 10000,
transferImmediatelyOnInbound: false,
maxCallDuration: 900,
voicemailDetectionMode: 'ASYNC',
minInterruptionWords: 1,
minInterruptionDuration: 1,
minEndpointingDelay: 0.5,
maxEndpointingDelay: 3,
vadActivationThreshold: 0.5,
sms: {
inactivityTimeoutHours: 2,
smsMaxTokens: 500,
smsTemperature: 0.7,
discardInboundSms: false
},
webChatAggregationWindowSeconds: 58,
emailDomainId: '<string>',
emailFromLocalPart: '<string>',
emailFromName: '<string>',
emailMaxTokens: 5050,
emailTemperature: 1,
emailInactivityTimeoutHours: 2,
warmTransferBriefingTemplate: '<string>',
warmTransferInteractive: true,
warmTransferInstructions: '<string>'
})
};
fetch('https://prod.featherhq.com/api/v1/agents', 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.featherhq.com/api/v1/agents",
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>',
'description' => '<string>',
'voicemailMessage' => '<string>',
'overrideSTTConfig' => [
'keywords' => [
[
'keyword' => '<string>',
'intensifier' => 'INTENSIFY'
]
]
],
'templateId' => '<string>',
'agentType' => 'CALL',
'useKnowledgeBase' => true,
'prompt' => [
'system' => '<string>',
'systemUIFormatting' => null,
'variables' => [
[
'name' => '<string>',
'required' => true,
'defaultValue' => '<string>'
]
],
'tools' => [
'<string>'
],
'preBuiltTools' => [
'<string>'
]
],
'promptPersonalityId' => '<string>',
'llmConfigId' => '<string>',
'languageId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sttConfigId' => '<string>',
'ttsConfigId' => '<string>',
'voiceId' => '<string>',
'enableBackgroundAudio' => false,
'backgroundAudio' => 50,
'voiceVolume' => 100,
'voiceSpeed' => 1,
'agentDelayBeforeFirstMessage' => 500,
'initialSilenceTimeout' => 30000,
'finalSilenceTimeout' => 10000,
'transferImmediatelyOnInbound' => false,
'maxCallDuration' => 900,
'voicemailDetectionMode' => 'ASYNC',
'minInterruptionWords' => 1,
'minInterruptionDuration' => 1,
'minEndpointingDelay' => 0.5,
'maxEndpointingDelay' => 3,
'vadActivationThreshold' => 0.5,
'sms' => [
'inactivityTimeoutHours' => 2,
'smsMaxTokens' => 500,
'smsTemperature' => 0.7,
'discardInboundSms' => false
],
'webChatAggregationWindowSeconds' => 58,
'emailDomainId' => '<string>',
'emailFromLocalPart' => '<string>',
'emailFromName' => '<string>',
'emailMaxTokens' => 5050,
'emailTemperature' => 1,
'emailInactivityTimeoutHours' => 2,
'warmTransferBriefingTemplate' => '<string>',
'warmTransferInteractive' => true,
'warmTransferInstructions' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.featherhq.com/api/v1/agents"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"voicemailMessage\": \"<string>\",\n \"overrideSTTConfig\": {\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": \"INTENSIFY\"\n }\n ]\n },\n \"templateId\": \"<string>\",\n \"agentType\": \"CALL\",\n \"useKnowledgeBase\": true,\n \"prompt\": {\n \"system\": \"<string>\",\n \"systemUIFormatting\": null,\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"preBuiltTools\": [\n \"<string>\"\n ]\n },\n \"promptPersonalityId\": \"<string>\",\n \"llmConfigId\": \"<string>\",\n \"languageId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sttConfigId\": \"<string>\",\n \"ttsConfigId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"enableBackgroundAudio\": false,\n \"backgroundAudio\": 50,\n \"voiceVolume\": 100,\n \"voiceSpeed\": 1,\n \"agentDelayBeforeFirstMessage\": 500,\n \"initialSilenceTimeout\": 30000,\n \"finalSilenceTimeout\": 10000,\n \"transferImmediatelyOnInbound\": false,\n \"maxCallDuration\": 900,\n \"voicemailDetectionMode\": \"ASYNC\",\n \"minInterruptionWords\": 1,\n \"minInterruptionDuration\": 1,\n \"minEndpointingDelay\": 0.5,\n \"maxEndpointingDelay\": 3,\n \"vadActivationThreshold\": 0.5,\n \"sms\": {\n \"inactivityTimeoutHours\": 2,\n \"smsMaxTokens\": 500,\n \"smsTemperature\": 0.7,\n \"discardInboundSms\": false\n },\n \"webChatAggregationWindowSeconds\": 58,\n \"emailDomainId\": \"<string>\",\n \"emailFromLocalPart\": \"<string>\",\n \"emailFromName\": \"<string>\",\n \"emailMaxTokens\": 5050,\n \"emailTemperature\": 1,\n \"emailInactivityTimeoutHours\": 2,\n \"warmTransferBriefingTemplate\": \"<string>\",\n \"warmTransferInteractive\": true,\n \"warmTransferInstructions\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.featherhq.com/api/v1/agents")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"voicemailMessage\": \"<string>\",\n \"overrideSTTConfig\": {\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": \"INTENSIFY\"\n }\n ]\n },\n \"templateId\": \"<string>\",\n \"agentType\": \"CALL\",\n \"useKnowledgeBase\": true,\n \"prompt\": {\n \"system\": \"<string>\",\n \"systemUIFormatting\": null,\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"preBuiltTools\": [\n \"<string>\"\n ]\n },\n \"promptPersonalityId\": \"<string>\",\n \"llmConfigId\": \"<string>\",\n \"languageId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sttConfigId\": \"<string>\",\n \"ttsConfigId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"enableBackgroundAudio\": false,\n \"backgroundAudio\": 50,\n \"voiceVolume\": 100,\n \"voiceSpeed\": 1,\n \"agentDelayBeforeFirstMessage\": 500,\n \"initialSilenceTimeout\": 30000,\n \"finalSilenceTimeout\": 10000,\n \"transferImmediatelyOnInbound\": false,\n \"maxCallDuration\": 900,\n \"voicemailDetectionMode\": \"ASYNC\",\n \"minInterruptionWords\": 1,\n \"minInterruptionDuration\": 1,\n \"minEndpointingDelay\": 0.5,\n \"maxEndpointingDelay\": 3,\n \"vadActivationThreshold\": 0.5,\n \"sms\": {\n \"inactivityTimeoutHours\": 2,\n \"smsMaxTokens\": 500,\n \"smsTemperature\": 0.7,\n \"discardInboundSms\": false\n },\n \"webChatAggregationWindowSeconds\": 58,\n \"emailDomainId\": \"<string>\",\n \"emailFromLocalPart\": \"<string>\",\n \"emailFromName\": \"<string>\",\n \"emailMaxTokens\": 5050,\n \"emailTemperature\": 1,\n \"emailInactivityTimeoutHours\": 2,\n \"warmTransferBriefingTemplate\": \"<string>\",\n \"warmTransferInteractive\": true,\n \"warmTransferInstructions\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod.featherhq.com/api/v1/agents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"voicemailMessage\": \"<string>\",\n \"overrideSTTConfig\": {\n \"keywords\": [\n {\n \"keyword\": \"<string>\",\n \"intensifier\": \"INTENSIFY\"\n }\n ]\n },\n \"templateId\": \"<string>\",\n \"agentType\": \"CALL\",\n \"useKnowledgeBase\": true,\n \"prompt\": {\n \"system\": \"<string>\",\n \"systemUIFormatting\": null,\n \"variables\": [\n {\n \"name\": \"<string>\",\n \"required\": true,\n \"defaultValue\": \"<string>\"\n }\n ],\n \"tools\": [\n \"<string>\"\n ],\n \"preBuiltTools\": [\n \"<string>\"\n ]\n },\n \"promptPersonalityId\": \"<string>\",\n \"llmConfigId\": \"<string>\",\n \"languageId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sttConfigId\": \"<string>\",\n \"ttsConfigId\": \"<string>\",\n \"voiceId\": \"<string>\",\n \"enableBackgroundAudio\": false,\n \"backgroundAudio\": 50,\n \"voiceVolume\": 100,\n \"voiceSpeed\": 1,\n \"agentDelayBeforeFirstMessage\": 500,\n \"initialSilenceTimeout\": 30000,\n \"finalSilenceTimeout\": 10000,\n \"transferImmediatelyOnInbound\": false,\n \"maxCallDuration\": 900,\n \"voicemailDetectionMode\": \"ASYNC\",\n \"minInterruptionWords\": 1,\n \"minInterruptionDuration\": 1,\n \"minEndpointingDelay\": 0.5,\n \"maxEndpointingDelay\": 3,\n \"vadActivationThreshold\": 0.5,\n \"sms\": {\n \"inactivityTimeoutHours\": 2,\n \"smsMaxTokens\": 500,\n \"smsTemperature\": 0.7,\n \"discardInboundSms\": false\n },\n \"webChatAggregationWindowSeconds\": 58,\n \"emailDomainId\": \"<string>\",\n \"emailFromLocalPart\": \"<string>\",\n \"emailFromName\": \"<string>\",\n \"emailMaxTokens\": 5050,\n \"emailTemperature\": 1,\n \"emailInactivityTimeoutHours\": 2,\n \"warmTransferBriefingTemplate\": \"<string>\",\n \"warmTransferInteractive\": true,\n \"warmTransferInstructions\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"agent": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"smsPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"inboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"outboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"version": {
"id": "<string>",
"version": 123,
"name": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"promptPersonalityId": "<string>",
"sttConfigId": "<string>",
"ttsConfigId": "<string>",
"llmConfigId": "<string>",
"overrideSTTConfig": {
"keywords": [
{
"keyword": "<string>",
"intensifier": "INTENSIFY"
}
]
},
"overrideTTSConfig": {
"pronunciations": []
},
"overrideLLMConfig": {},
"voiceId": "<string>",
"postCallPrompt": "<string>",
"postCallVariables": [
{
"variableName": "<string>",
"description": "<string>",
"required": false
}
],
"knowledgeBaseCollectionIds": [
"<string>"
],
"voicemailMessage": "<string>",
"firstMessage": "<string>",
"forwardingPhoneNumber": "<string>",
"warmTransferBriefingTemplate": "<string>",
"warmTransferInstructions": "<string>",
"inactivityTimeoutHours": 2,
"smsMaxTokens": 1050,
"smsTemperature": 1,
"webChatAggregationWindowSeconds": 58,
"prompt": {
"system": "<string>",
"systemUIFormatting": null,
"variables": [
{
"name": "<string>",
"required": true,
"defaultValue": "<string>"
}
],
"tools": [
"<string>"
],
"preBuiltTools": [
"<string>"
]
},
"voicemailDetectionMode": "ASYNC",
"speakFirst": false,
"useKnowledgeBase": true,
"enableBackgroundAudio": false,
"backgroundAudio": 50,
"voiceVolume": 100,
"warmTransferInteractive": false,
"voiceSpeed": 1,
"agentDelayBeforeFirstMessage": 500,
"initialSilenceTimeout": 30000,
"finalSilenceTimeout": 10000,
"maxCallDuration": 900,
"minInterruptionWords": 1,
"minInterruptionDuration": 1,
"minEndpointingDelay": 0.5,
"maxEndpointingDelay": 3,
"vadActivationThreshold": 0.5,
"language": {
"languageId": "<string>",
"languageDisplayName": "<string>"
},
"transferImmediatelyOnInbound": false,
"discardInboundSms": false,
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2,
"emailFilteringEnabled": false,
"emailResponseMode": "AUTO_SEND",
"emailConfidenceThreshold": 0.8,
"emailTags": [
{
"name": "<string>",
"prompt": "<string>",
"autoClose": true,
"gmailLabelId": "<string>",
"gmailLabelName": "<string>"
}
],
"sentimentAnalysis": false,
"preCallWebhook": {
"mode": "tool",
"toolId": "<string>",
"toolSlug": "<string>"
}
},
"callObservabilityEnabled": false
}
}{
"status": 400,
"message": "Bad request",
"code": "BAD_REQUEST",
"success": false
}{
"status": 500,
"message": "Internal server error",
"code": "INTERNAL_SERVER_ERROR",
"success": false
}Authorizations
Body
application/json
Show child attributes
Show child attributes
Available options:
CALL, TEXT Show child attributes
Show child attributes
Required range:
0 < x < 100Required range:
10 <= x <= 120Required range:
0.8 <= x <= 1.2Required range:
0 <= x <= 2500Required range:
0 <= x <= 60000Required range:
0 <= x <= 60000Required range:
300 <= x <= 6000Available options:
ASYNC, SYNC Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
x >= 0Required range:
0.1 <= x <= 0.9Show child attributes
Show child attributes
Required range:
1 <= x <= 115Required range:
100 <= x <= 10000Required range:
0 <= x <= 2Required range:
x >= 1Available options:
STATIC, PROMPT Response
Agent created successfully
Show child attributes
Show child attributes
⌘I