Skip to content

🌿 ✨ [Scheduled] Update API Spec #248

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Mar 10, 2025
Merged

🌿 ✨ [Scheduled] Update API Spec #248

Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
2bb10e7
fix(openapi): add keypad input plan and remove TrieveKnowledgeBaseCre…
fern-api[bot] Feb 27, 2025
f2a71af
feat(openapi): add support for Supabase storage and Anthropic thinkin…
fern-api[bot] Feb 28, 2025
c8b18cf
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
fern-api[bot] Mar 2, 2025
67329e0
feat(openapi): add support for Hume AI voices and GPT-4.5-preview model
fern-api[bot] Mar 2, 2025
7e2a8e3
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
fern-api[bot] Mar 4, 2025
1707f55
feat(openapi.json): added Vapi as a voice provider and fallback voice
fern-api[bot] Mar 4, 2025
b73c7af
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
fern-api[bot] Mar 5, 2025
a877a76
feat(openapi): add QueryTool to OpenAPI spec
fern-api[bot] Mar 5, 2025
db957b1
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
fern-api[bot] Mar 7, 2025
9ee8a61
fix(fern/apis/api/openapi.json): Update model and provider field type…
fern-api[bot] Mar 7, 2025
aa0f980
Merge remote-tracking branch 'origin/main' into fern/update-api-specs
fern-api[bot] Mar 9, 2025
ec8033b
feat(openapi): add and update voicemail detection and invoice plan
fern-api[bot] Mar 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
193 changes: 148 additions & 45 deletions fern/apis/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10827,7 +10827,12 @@
"type": "string",
"description": "The voices provided by Vapi",
"enum": [
"Jordan"
"Jordan",
"Adi",
"Julia",
"Maibri (Web)",
"Maibri (Phone)",
"Ashley"
]
},
"chunkPlan": {
Expand Down Expand Up @@ -12337,7 +12342,7 @@
"type"
]
},
"TwilioVoicemailDetection": {
"TwilioVoicemailDetectionPlan": {
"type": "object",
"properties": {
"provider": {
Expand Down Expand Up @@ -12409,6 +12414,29 @@
"provider"
]
},
"GoogleVoicemailDetectionPlan": {
"type": "object",
"properties": {
"provider": {
"type": "string",
"description": "This is the provider to use for voicemail detection.",
"enum": [
"google"
]
},
"voicemailExpectedDurationSeconds": {
"type": "number",
"description": "This is how long should we listen in order to determine if we were sent to voicemail or not?\n\n@default 15",
"minimum": 5,
"maximum": 60,
"default": 15
}
},
"required": [
"provider",
"voicemailExpectedDurationSeconds"
]
},
"CompliancePlan": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -13027,15 +13055,7 @@
"#",
"*",
""
],
"x-fern-enum": {
"#": {
"name": "Hash"
},
"*": {
"name": "Asterisk"
}
}
]
}
}
},
Expand Down Expand Up @@ -13204,6 +13224,10 @@
],
"example": "assistant-speaks-first"
},
"voicemailDetection": {
"type": "object",
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not."
},
"clientMessages": {
"type": "array",
"enum": [
Expand Down Expand Up @@ -13512,14 +13536,6 @@
"description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
"maxLength": 40
},
"voicemailDetection": {
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
"allOf": [
{
"$ref": "#/components/schemas/TwilioVoicemailDetection"
}
]
},
"voicemailMessage": {
"type": "string",
"description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
Expand Down Expand Up @@ -13786,6 +13802,10 @@
],
"example": "assistant-speaks-first"
},
"voicemailDetection": {
"type": "object",
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not."
},
"clientMessages": {
"type": "array",
"enum": [
Expand Down Expand Up @@ -14098,14 +14118,6 @@
"description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
"maxLength": 40
},
"voicemailDetection": {
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
"allOf": [
{
"$ref": "#/components/schemas/TwilioVoicemailDetection"
}
]
},
"voicemailMessage": {
"type": "string",
"description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
Expand Down Expand Up @@ -14661,6 +14673,10 @@
"$ref": "#/components/schemas/VapiCost",
"title": "VapiCost"
},
{
"$ref": "#/components/schemas/VoicemailDetectionCost",
"title": "VoicemailDetectionCost"
},
{
"$ref": "#/components/schemas/AnalysisCost",
"title": "AnalysisCost"
Expand Down Expand Up @@ -15429,6 +15445,10 @@
],
"example": "assistant-speaks-first"
},
"voicemailDetection": {
"type": "object",
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not."
},
"clientMessages": {
"type": "array",
"enum": [
Expand Down Expand Up @@ -15737,14 +15757,6 @@
"description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
"maxLength": 40
},
"voicemailDetection": {
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
"allOf": [
{
"$ref": "#/components/schemas/TwilioVoicemailDetection"
}
]
},
"voicemailMessage": {
"type": "string",
"description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
Expand Down Expand Up @@ -16035,6 +16047,10 @@
],
"example": "assistant-speaks-first"
},
"voicemailDetection": {
"type": "object",
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not."
},
"clientMessages": {
"type": "array",
"enum": [
Expand Down Expand Up @@ -16343,14 +16359,6 @@
"description": "This is the name of the assistant.\n\nThis is required when you want to transfer between assistants in a call.",
"maxLength": 40
},
"voicemailDetection": {
"description": "These are the settings to configure or disable voicemail detection. Alternatively, voicemail detection can be configured using the model.tools=[VoicemailTool].\nThis uses Twilio's built-in detection while the VoicemailTool relies on the model to detect if a voicemail was reached.\nYou can use neither of them, one of them, or both of them. By default, Twilio built-in detection is enabled while VoicemailTool is not.",
"allOf": [
{
"$ref": "#/components/schemas/TwilioVoicemailDetection"
}
]
},
"voicemailMessage": {
"type": "string",
"description": "This is the message that the assistant will say if the call is forwarded to voicemail.\n\nIf unspecified, it will hang up.",
Expand Down Expand Up @@ -20672,8 +20680,9 @@
},
"status": {
"enum": [
"indexed",
"not_indexed"
"processing",
"done",
"failed"
],
"type": "string"
},
Expand Down Expand Up @@ -20706,6 +20715,12 @@
"url": {
"type": "string"
},
"parsedTextUrl": {
"type": "string"
},
"parsedTextBytes": {
"type": "number"
},
"metadata": {
"type": "object"
},
Expand Down Expand Up @@ -24619,6 +24634,27 @@
"threshold"
]
},
"InvoicePlan": {
"type": "object",
"properties": {
"companyName": {
"type": "string",
"description": "This is the name of the company."
},
"companyAddress": {
"type": "string",
"description": "This is the address of the company."
},
"companyTaxId": {
"type": "string",
"description": "This is the tax ID of the company."
},
"companyEmail": {
"type": "string",
"description": "This is the preferred invoicing email of the company. If not specified, defaults to the subscription's email."
}
}
},
"Subscription": {
"type": "object",
"properties": {
Expand Down Expand Up @@ -24785,6 +24821,14 @@
"couponUsageLeft": {
"type": "string",
"description": "This is the number of credits left obtained from a coupon."
},
"invoicePlan": {
"description": "This is the invoice plan for the subscription.",
"allOf": [
{
"$ref": "#/components/schemas/InvoicePlan"
}
]
}
},
"required": [
Expand Down Expand Up @@ -27292,6 +27336,10 @@
"$ref": "#/components/schemas/VapiCost",
"title": "VapiCost"
},
{
"$ref": "#/components/schemas/VoicemailDetectionCost",
"title": "VoicemailDetectionCost"
},
{
"$ref": "#/components/schemas/AnalysisCost",
"title": "AnalysisCost"
Expand Down Expand Up @@ -29721,6 +29769,61 @@
"cost"
]
},
"VoicemailDetectionCost": {
"type": "object",
"properties": {
"type": {
"type": "string",
"description": "This is the type of cost, always 'voicemail-detection' for this class.",
"enum": [
"voicemail-detection"
]
},
"model": {
"type": "object",
"description": "This is the model that was used to perform the analysis."
},
"provider": {
"type": "string",
"description": "This is the provider that was used to detect the voicemail.",
"enum": [
"twilio",
"google",
"openai"
]
},
"promptTextTokens": {
"type": "number",
"description": "This is the number of prompt text tokens used in the voicemail detection."
},
"promptAudioTokens": {
"type": "number",
"description": "This is the number of prompt audio tokens used in the voicemail detection."
},
"completionTextTokens": {
"type": "number",
"description": "This is the number of completion text tokens used in the voicemail detection."
},
"completionAudioTokens": {
"type": "number",
"description": "This is the number of completion audio tokens used in the voicemail detection."
},
"cost": {
"type": "number",
"description": "This is the cost of the component in USD."
}
},
"required": [
"type",
"model",
"provider",
"promptTextTokens",
"promptAudioTokens",
"completionTextTokens",
"completionAudioTokens",
"cost"
]
},
"FunctionToolWithToolCall": {
"type": "object",
"properties": {
Expand Down
Loading