Skip to main content
POST
/
api
/
v1
/
agents
Create a new agent
curl --request POST \
  --url https://prod.featherhq.com/api/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "templateId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "voicemailMessage": "<string>",
  "useKnowledgeBase": true,
  "prompt": {
    "system": "<string>",
    "systemUIFormatting": "<any>",
    "variables": [
      {
        "name": "<string>",
        "required": true,
        "defaultValue": "<string>"
      }
    ],
    "tools": [
      "<string>"
    ],
    "preBuiltTools": [
      "<string>"
    ]
  },
  "promptPersonalityId": "<string>",
  "sttConfigId": "<string>",
  "ttsConfigId": "<string>",
  "llmConfigId": "<string>",
  "overrideSTTConfig": {
    "keywords": [
      {
        "keyword": "<string>",
        "intensifier": "INTENSIFY"
      }
    ]
  },
  "voiceId": "<string>",
  "enableBackgroundAudio": false,
  "backgroundAudio": 50,
  "voiceVolume": 100,
  "voiceSpeed": 1,
  "languageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentDelayBeforeFirstMessage": 500,
  "initialSilenceTimeout": 30000,
  "finalSilenceTimeout": 10000,
  "transferImmediatelyOnInbound": false,
  "maxCallDuration": 900
}'
{
  "agent": {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "inboundPhoneNumbers": [
      {
        "id": "<string>"
      }
    ],
    "outboundPhoneNumbers": [
      {
        "id": "<string>"
      }
    ],
    "cekuraAgentId": 123,
    "cekuraPhoneNumberId": "<string>",
    "callObservabilityEnabled": false,
    "version": {
      "id": "<string>",
      "version": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "mode": "FLOW",
      "prompt": {
        "system": "<string>",
        "systemUIFormatting": "<any>",
        "variables": [
          {
            "name": "<string>",
            "required": true,
            "defaultValue": "<string>"
          }
        ],
        "tools": [
          "<string>"
        ],
        "preBuiltTools": [
          "<string>"
        ]
      },
      "promptPersonalityId": "<string>",
      "sttConfigId": "<string>",
      "ttsConfigId": "<string>",
      "llmConfigId": "<string>",
      "overrideSTTConfig": {
        "keywords": [
          {
            "keyword": "<string>",
            "intensifier": "INTENSIFY"
          }
        ]
      },
      "overrideTTSConfig": {
        "pronunciations": []
      },
      "overrideLLMConfig": {},
      "voiceId": "<string>",
      "postCallPrompt": "<string>",
      "postCallVariables": [
        {
          "variableName": "<string>",
          "type": "STRING",
          "description": "<string>",
          "required": false
        }
      ],
      "knowledgeBaseCollectionIds": [
        "<string>"
      ],
      "voicemailMessage": "<string>",
      "speakFirst": false,
      "firstMessage": "<string>",
      "useKnowledgeBase": true,
      "enableBackgroundAudio": false,
      "backgroundAudio": 50,
      "voiceVolume": 100,
      "forwardingPhoneNumber": "<string>",
      "voiceSpeed": 1,
      "agentDelayBeforeFirstMessage": 500,
      "initialSilenceTimeout": 30000,
      "finalSilenceTimeout": 10000,
      "maxCallDuration": 900,
      "language": {
        "languageId": "<string>",
        "languageCode": "EN",
        "languageDisplayName": "<string>"
      },
      "transferImmediatelyOnInbound": false
    }
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required
description
string | null
required
voicemailMessage
string | null
required
overrideSTTConfig
object | null
required
templateId
string
useKnowledgeBase
boolean
default:true
prompt
object | null
promptPersonalityId
string | null
sttConfigId
string | null
ttsConfigId
string | null
llmConfigId
string | null
voiceId
string | null
enableBackgroundAudio
boolean
default:false
backgroundAudio
number
default:50
Required range: 0 < x < 100
voiceVolume
integer
default:100
Required range: 10 <= x <= 120
voiceSpeed
number
default:1
Required range: 0.8 <= x <= 1.2
languageId
string<uuid> | null
agentDelayBeforeFirstMessage
integer
default:500
Required range: 0 <= x <= 2500
initialSilenceTimeout
integer
default:30000
Required range: 0 <= x <= 60000
finalSilenceTimeout
integer
default:10000
Required range: 0 <= x <= 60000
transferImmediatelyOnInbound
boolean
default:false
maxCallDuration
integer
default:900
Required range: 300 <= x <= 1200

Response

New agent version created successfully

agent
object
required