Skip to main content
PATCH
/
api
/
v1
/
agents
/
{agentId}
/
versions
/
{versionId}
Update agent version
curl --request PATCH \
  --url https://prod.featherhq.com/api/v1/agents/{agentId}/versions/{versionId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "mode": "FLOW",
  "prompt": {
    "system": "<string>",
    "systemUIFormatting": null,
    "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>",
  "knowledgeBaseCollectionIds": [
    "<string>"
  ],
  "voicemailMessage": "<string>",
  "voicemailDetectionMode": "ASYNC",
  "speakFirst": true,
  "firstMessage": "<string>",
  "useKnowledgeBase": true,
  "enableBackgroundAudio": true,
  "backgroundAudio": 50,
  "voiceVolume": 65,
  "voiceSpeed": 1,
  "forwardingPhoneNumber": "<string>",
  "postCallVariables": [
    {
      "variableName": "<string>",
      "type": "STRING",
      "description": "<string>",
      "required": false
    }
  ],
  "languageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "agentDelayBeforeFirstMessage": 1250,
  "initialSilenceTimeout": 30000,
  "finalSilenceTimeout": 30000,
  "transferImmediatelyOnInbound": true,
  "maxCallDuration": 750,
  "minInterruptionWords": 1,
  "minInterruptionDuration": 1,
  "minEndpointingDelay": 1,
  "maxEndpointingDelay": 1,
  "inactivityTimeoutHours": 2,
  "smsMaxTokens": 1050,
  "smsTemperature": 1,
  "emailDomainId": "<string>",
  "emailFromLocalPart": "<string>",
  "emailFromName": "<string>",
  "emailMaxTokens": 5050,
  "emailTemperature": 1,
  "emailInactivityTimeoutHours": 2
}
'
{
  "version": {
    "id": "<string>",
    "version": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "mode": "FLOW",
    "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>",
    "firstMessage": "<string>",
    "forwardingPhoneNumber": "<string>",
    "inactivityTimeoutHours": 2,
    "smsMaxTokens": 1050,
    "smsTemperature": 1,
    "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,
    "voiceSpeed": 1,
    "agentDelayBeforeFirstMessage": 500,
    "initialSilenceTimeout": 30000,
    "finalSilenceTimeout": 10000,
    "maxCallDuration": 900,
    "minInterruptionWords": 1,
    "minInterruptionDuration": 1,
    "minEndpointingDelay": 0.5,
    "maxEndpointingDelay": 3,
    "language": {
      "languageId": "<string>",
      "languageCode": "EN",
      "languageDisplayName": "<string>"
    },
    "transferImmediatelyOnInbound": false,
    "emailDomainId": "<string>",
    "emailFromLocalPart": "<string>",
    "emailFromName": "<string>",
    "emailMaxTokens": 5050,
    "emailTemperature": 1,
    "emailInactivityTimeoutHours": 2
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.featherhq.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
agentId
string
required
​
versionId
string
required

Body

application/json
​
mode
enum<string>
Available options:
FLOW,
PROMPT
​
prompt
object
​
promptPersonalityId
string | null
​
sttConfigId
string | null
​
ttsConfigId
string | null
​
llmConfigId
string | null
​
overrideSTTConfig
object
​
overrideTTSConfig
object
​
overrideLLMConfig
object
​
voiceId
string | null
​
postCallPrompt
string | null
​
knowledgeBaseCollectionIds
string[]
​
voicemailMessage
string | null
​
voicemailDetectionMode
enum<string>
Available options:
ASYNC,
SYNC
​
speakFirst
boolean
​
firstMessage
string | null
​
useKnowledgeBase
boolean
​
enableBackgroundAudio
boolean
​
backgroundAudio
number
Required range: 0 <= x <= 100
​
voiceVolume
integer
Required range: 10 <= x <= 120
​
voiceSpeed
number
Required range: 0.8 <= x <= 1.2
​
forwardingPhoneNumber
string | null
Pattern: ^\+1(\d{10}|\d{3}-\d{3}-\d{4})|^\+[1-9]\d{1,14}$
​
postCallVariables
object[] | null
​
languageId
string<uuid>
​
agentDelayBeforeFirstMessage
integer
Required range: 0 <= x <= 2500
​
initialSilenceTimeout
integer
Required range: 0 <= x <= 60000
​
finalSilenceTimeout
integer
Required range: 0 <= x <= 60000
​
transferImmediatelyOnInbound
boolean
​
maxCallDuration
integer
Required range: 300 <= x <= 1200
​
minInterruptionWords
integer
Required range: x >= 0
​
minInterruptionDuration
number
Required range: x >= 0
​
minEndpointingDelay
number
Required range: x >= 0
​
maxEndpointingDelay
number
Required range: x >= 0
​
inactivityTimeoutHours
integer | null
Required range: x >= 1
​
smsMaxTokens
integer
Required range: 100 <= x <= 2000
​
smsTemperature
number
Required range: 0 <= x <= 2
​
emailDomainId
string | null
​
emailFromLocalPart
string | null
​
emailFromName
string | null
​
emailMaxTokens
integer | null
Required range: 100 <= x <= 10000
​
emailTemperature
number | null
Required range: 0 <= x <= 2
​
emailInactivityTimeoutHours
integer | null
Required range: x >= 1

Response

Agent version updated successfully

​
version
object
required