Skip to content

🌿 ✨ [Scheduled] Update API Spec #220

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 1 commit into from
Feb 21, 2025
Merged

🌿 ✨ [Scheduled] Update API Spec #220

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
77 changes: 70 additions & 7 deletions fern/apis/api/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6434,6 +6434,7 @@
"type": "string",
"description": "This is the OpenAI model that will be used.",
"enum": [
"chatgpt-4o-latest",
"o3-mini",
"o1-preview",
"o1-preview-2024-09-12",
Expand Down Expand Up @@ -6466,6 +6467,7 @@
"type": "array",
"description": "These are the fallback models that will be used if the primary model fails. This shouldn't be specified unless you have a specific reason to do so. Vapi will automatically find the fastest fallbacks that make sense.",
"enum": [
"chatgpt-4o-latest",
"o3-mini",
"o1-preview",
"o1-preview-2024-09-12",
Expand Down Expand Up @@ -6500,6 +6502,7 @@
"items": {
"type": "string",
"enum": [
"chatgpt-4o-latest",
"o3-mini",
"o1-preview",
"o1-preview-2024-09-12",
Expand Down Expand Up @@ -7618,6 +7621,50 @@
"voiceId"
]
},
"CartesiaExperimentalControls": {
"type": "object",
"properties": {
"speed": {
"type": "string",
"enum": [
"slowest",
"slow",
"normal",
"fast",
"fastest"
],
"example": "normal"
},
"emotion": {
"type": "string",
"enum": [
"anger:lowest",
"anger:low",
"anger:high",
"anger:highest",
"positivity:lowest",
"positivity:low",
"positivity:high",
"positivity:highest",
"surprise:lowest",
"surprise:low",
"surprise:high",
"surprise:highest",
"sadness:lowest",
"sadness:low",
"sadness:high",
"sadness:highest",
"curiosity:lowest",
"curiosity:low",
"curiosity:high",
"curiosity:highest"
],
"example": [
"happiness:high"
]
}
}
},
"CartesiaVoice": {
"type": "object",
"properties": {
Expand All @@ -7628,6 +7675,10 @@
"cartesia"
]
},
"voiceId": {
"type": "string",
"description": "The ID of the particular voice you want to use."
},
"model": {
"type": "string",
"description": "This is the model that will be used. This is optional and will default to the correct model for the voiceId.",
Expand Down Expand Up @@ -7661,6 +7712,14 @@
],
"example": "en"
},
"experimentalControls": {
"description": "Experimental controls for Cartesia voice generation",
"allOf": [
{
"$ref": "#/components/schemas/CartesiaExperimentalControls"
}
]
},
"chunkPlan": {
"description": "This is the plan for chunking the model output before it is sent to the voice provider.",
"allOf": [
Expand All @@ -7669,10 +7728,6 @@
}
]
},
"voiceId": {
"type": "string",
"description": "This is the provider-specific ID that will be used."
},
"fallbackPlan": {
"description": "This is the plan for voice provider fallbacks in the event that the primary voice provider fails.",
"allOf": [
Expand Down Expand Up @@ -8657,6 +8712,10 @@
"cartesia"
]
},
"voiceId": {
"type": "string",
"description": "The ID of the particular voice you want to use."
},
"model": {
"type": "string",
"description": "This is the model that will be used. This is optional and will default to the correct model for the voiceId.",
Expand Down Expand Up @@ -8690,9 +8749,13 @@
],
"example": "en"
},
"voiceId": {
"type": "string",
"description": "This is the provider-specific ID that will be used."
"experimentalControls": {
"description": "Experimental controls for Cartesia voice generation",
"allOf": [
{
"$ref": "#/components/schemas/CartesiaExperimentalControls"
}
]
},
"chunkPlan": {
"description": "This is the plan for chunking the model output before it is sent to the voice provider.",
Expand Down
Loading