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,
"sms": {
"inactivityTimeoutHours": 2,
"smsMaxTokens": 500,
"smsTemperature": 0.7
},
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2
}
'{
"agent": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"agentType": "CALL",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"smsPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"ownership": "FEATHER",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"inboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"ownership": "FEATHER",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"outboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"ownership": "FEATHER",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"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
},
"callObservabilityEnabled": false
}
}Create a new voice or text (SMS) 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,
"sms": {
"inactivityTimeoutHours": 2,
"smsMaxTokens": 500,
"smsTemperature": 0.7
},
"emailDomainId": "<string>",
"emailFromLocalPart": "<string>",
"emailFromName": "<string>",
"emailMaxTokens": 5050,
"emailTemperature": 1,
"emailInactivityTimeoutHours": 2
}
'{
"agent": {
"id": "<string>",
"name": "<string>",
"description": "<string>",
"agentType": "CALL",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"smsPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"ownership": "FEATHER",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"inboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"ownership": "FEATHER",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"outboundPhoneNumbers": [
{
"id": "<string>",
"phoneNumber": "<string>",
"ownership": "FEATHER",
"createdAt": "<string>",
"updatedAt": "<string>"
}
],
"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
},
"callObservabilityEnabled": false
}
}Show child attributes
CALL, TEXT Show child attributes
0 < x < 10010 <= x <= 1200.8 <= x <= 1.20 <= x <= 25000 <= x <= 600000 <= x <= 60000300 <= x <= 1200ASYNC, SYNC x >= 0x >= 0x >= 0x >= 0Show child attributes
100 <= x <= 100000 <= x <= 2x >= 1Agent created successfully
Show child attributes