Skip to content

feat: Update OpenAPI spec for agent definition validation #438

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

Open
khushalsonawat wants to merge 2 commits into
base: dev
Choose a base branch
from
Open

feat: Update OpenAPI spec for agent definition validation #438

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c125c7
feat: update OpenAPI spec for agent definition validation constraints
khushalsonawat Mar 3, 2026
45cdfdb
feat: document provider required for voice, outbound vapi-only
khushalsonawat Mar 4, 2026
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
54 changes: 40 additions & 14 deletions openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,29 +186,39 @@
},
"agentName": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"description": "Name of the agent."
},
"provider": {
"type": "string",
"description": "Provider for the agent (e.g., vapi, retell).",
"enum": ["vapi", "retell"]
"description": "Provider for the agent. Required for all voice agents. Outbound calls are only supported with the `vapi` provider.",
"enum": ["vapi", "retell", "eleven_labs", "others"]
},
"apiKey": {
"type": "string",
"format": "uuid",
"description": "API key for the agent provider."
"description": "API key for the agent provider. Required for outbound agents."
},
"assistantId": {
"type": "string",
"description": "External identifier for the assistant."
"description": "External identifier for the assistant. Required for outbound agents."
},
"description": {
"type": "string",
"minLength": 1,
"description": "Description for the first version of the agent."
},
"language": {
"type": "string",
"description": "Language of the agent ([ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) code, for example, `en` for English)."
"description": "Primary language of the agent ([ISO 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes) code, for example, `en` for English)."
},
"languages": {
"type": "array",
"items": {
"type": "string"
},
"minItems": 1,
"description": "List of supported languages (ISO 639-1 codes). At least one language is required."
},
"knowledgeBase": {
"type": "string",
Expand All @@ -222,14 +232,17 @@
},
"contactNumber": {
"type": "string",
"description": "Contact number for the agent including country code. For example, +1xxxxxxxxxx for USA, +91xxxxxxxxxx for India, etc."
"pattern": "^\\+?\\d{10,15}$",
"description": "Contact number for the agent including country code. Required for voice agents. For example, +1xxxxxxxxxx for USA, +91xxxxxxxxxx for India, etc."
},
"inbound": {
"type": "boolean",
"default": true,
"description": "Specifies if the agent handles inbound communication."
},
"commitMessage": {
"type": "string",
"minLength": 1,
"description": "Commit message for the initial version of the agent."
},
"observabilityEnabled": {
Expand All @@ -239,9 +252,11 @@
},
"required": [
"agentName",
"provider",
"language",
"contactNumber"
"agentType",
"languages",
"description",
"commitMessage",
"inbound"
]
},
"examples": {
Expand Down Expand Up @@ -2157,13 +2172,17 @@
"format": "uuid"
},
"agent_name": {
"type": "string"
"type": "string",
"minLength": 1,
"maxLength": 255
},
"agent_type": {
"type": "string"
"type": "string",
"enum": ["voice", "text"]
},
"contact_number": {
"type": "string"
"type": "string",
"pattern": "^\\+?\\d{10,15}$"
},
"inbound": {
"type": "boolean"
Expand All @@ -2175,11 +2194,18 @@
"type": "string"
},
"provider": {
"type": "string"
"type": "string",
"enum": ["vapi", "retell", "eleven_labs", "others"]
},
"language": {
"type": "string"
},
"languages": {
"type": "array",
"items": {
"type": "string"
}
},
"websocket_url": {
"type": "string",
"format": "uri",
Expand Down