Authorizations
Body
application/json
Available options:
FLOW
, PROMPT
Required range:
0 <= x <= 100
Response
Agent version updated successfully
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": "<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": {},
"overrideLLMConfig": {},
"voiceId": "<string>",
"postCallPrompt": "<string>",
"knowledgeBaseCollectionIds": [
"<string>"
],
"voicemailMessage": "<string>",
"speakFirst": true,
"firstMessage": "<string>",
"useKnowledgeBase": true,
"enableBackgroundAudio": true,
"backgroundAudio": 50,
"forwardingPhoneNumber": "<string>",
"postCallVariables": [
{
"variableName": "<string>",
"type": "STRING",
"description": "<string>",
"required": 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": {},
"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,
"forwardingPhoneNumber": "<string>"
}
}
Update an existing 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": "<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": {},
"overrideLLMConfig": {},
"voiceId": "<string>",
"postCallPrompt": "<string>",
"knowledgeBaseCollectionIds": [
"<string>"
],
"voicemailMessage": "<string>",
"speakFirst": true,
"firstMessage": "<string>",
"useKnowledgeBase": true,
"enableBackgroundAudio": true,
"backgroundAudio": 50,
"forwardingPhoneNumber": "<string>",
"postCallVariables": [
{
"variableName": "<string>",
"type": "STRING",
"description": "<string>",
"required": 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": {},
"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,
"forwardingPhoneNumber": "<string>"
}
}
FLOW
, PROMPT
Show child attributes
Show child attributes
Show child attributes
Show child attributes
0 <= x <= 100
Show child attributes
Agent version updated successfully
Show child attributes