feat:Update openapi.yaml: Add batch-calling endpoint and update schemas#71
feat:Update openapi.yaml: Add batch-calling endpoint and update schemas#71
Conversation
WalkthroughThe changes modify the Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant API
Client->>API: POST /v1/convai/batch-calling/submit (API key + request body)
API-->>Client: BatchCallResponse (batch_id, phone_number_id, agent_id, status, created_at_unix)
Possibly related PRs
Suggested reviewers
Poem
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
coderabbitai
Bot
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
src/libs/ElevenLabs/openapi.yaml (6)
10848-10855: Default Empty String foridProperty (Hunk 15).
A default empty string is now set for theidproperty. Please verify that an empty default is acceptable for your application logic and that downstream consumers handle it correctly.
10895-10904: Default Empty String foridProperty (Hunk 16).
This hunk similarly introduces an empty string default for theidfield. Confirm that this behavior is consistent with your schema design and does not lead to unintended consequences.
11025-11032: Addition oftierProperty in Conversation Configurations (Hunk 17).
A new propertytieris added, marked as nullable. It would be helpful to document what values are expected for this field and to consider adding an enum if there are specific tiers defined.
16831-16840: Default Empty String foridProperty (Hunk 20).
Once again, a default empty string is set for theidproperty in this schema segment. Consistency is key; please ensure this default value is acceptable throughout your API.
18242-18251: Default Empty String foridProperty in API Schema (Hunk 21).
The schema update includes a default empty string forid. Review whether this convention is consistently applied across all similar schemas and that it meets the consumers’ expectations.
18277-18286: Default Empty String foridProperty in API Schema (Hunk 22).
This final hunk mirrors the previous default-setting changes for theidfield. A brief validation to ensure these defaults do not interfere with entity uniqueness or processing logic is suggested.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (56)
src/libs/ElevenLabs/Generated/ElevenLabs.AudioIsolationClient.CreateAudioIsolation.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.AudioIsolationClient.CreateAudioIsolationStream.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.CreateConvaiAgentsCreate.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.CreateConvaiBatchCallingSubmit.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ConversationalAIClient.EditConvaiAgentsByAgentId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IAudioIsolationClient.CreateAudioIsolation.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IAudioIsolationClient.CreateAudioIsolationStream.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.CreateConvaiAgentsCreate.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.CreateConvaiBatchCallingSubmit.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.IConversationalAIClient.EditConvaiAgentsByAgentId.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.ISpeechToTextClient.CreateSpeechToText.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BatchCallResponse.Json.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BatchCallResponse.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BatchCallStatisticsResponseModel.Json.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BatchCallStatisticsResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BatchCallStatusResponseModel.Json.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BatchCallStatusResponseModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BatchCallStatusResponseModelStatus.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyAudioIsolationStreamV1AudioIsolationStreamPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyAudioIsolationStreamV1AudioIsolationStreamPostFileFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyAudioIsolationV1AudioIsolationPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodyAudioIsolationV1AudioIsolationPostFileFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodySpeechToTextV1SpeechToTextPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodySpeechToTextV1SpeechToTextPostFileFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodySubmitABatchCallRequestV1ConvaiBatchCallingSubmitPost.Json.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.BodySubmitABatchCallRequestV1ConvaiBatchCallingSubmitPost.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ClientToolConfigInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ClientToolConfigOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationChargingCommonModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationHistoryMetadataCommonModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationHistoryRagUsageCommonModel.Json.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.ConversationHistoryRagUsageCommonModel.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.GenerateAVoicePreviewFromDescriptionV1TextToVoiceCreatePreviewsPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.OutboundCallRecipient.Json.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.OutboundCallRecipient.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SoundGenerationV1SoundGenerationPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SpeechToSpeechStreamingV1SpeechToSpeechVoiceIdStreamPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SpeechToSpeechV1SpeechToSpeechVoiceIdPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.SystemToolConfig.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechStreamingV1TextToSpeechVoiceIdStreamPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechStreamingWithTimestampsV1TextToSpeechVoiceIdStreamWithTimestampsPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechV1TextToSpeechVoiceIdPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.TextToSpeechWithTimestampsV1TextToSpeechVoiceIdWithTimestampsPostOutputFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolConfigInput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.Models.WebhookToolConfigOutput.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/ElevenLabs.SpeechToTextClient.CreateSpeechToText.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BatchCallStatusResponseModelStatus.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BatchCallStatusResponseModelStatusNullable.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BodyAudioIsolationStreamV1AudioIsolationStreamPostFileFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BodyAudioIsolationStreamV1AudioIsolationStreamPostFileFormatNullable.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BodyAudioIsolationV1AudioIsolationPostFileFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BodyAudioIsolationV1AudioIsolationPostFileFormatNullable.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BodySpeechToTextV1SpeechToTextPostFileFormat.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonConverters.BodySpeechToTextV1SpeechToTextPostFileFormatNullable.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonSerializerContext.g.csis excluded by!**/generated/**src/libs/ElevenLabs/Generated/JsonSerializerContextTypes.g.csis excluded by!**/generated/**
📒 Files selected for processing (1)
src/libs/ElevenLabs/openapi.yaml(22 hunks)
🔇 Additional comments (16)
src/libs/ElevenLabs/openapi.yaml (16)
273-279: Addition ofalaw_8000audio format option (Hunk 1).
The new optionalaw_8000has been added to the list of supported audio formats. This change appears consistent with the updated API specifications.
537-543: Addition ofalaw_8000audio format option (Hunk 2).
Similar to Hunk 1, the inclusion ofalaw_8000here ensures expanded support for audio formats.
629-635: Addition ofalaw_8000audio format option (Hunk 3).
The update continues the pattern by adding thealaw_8000option, improving format options available to clients.
720-726: Addition ofalaw_8000audio format option (Hunk 4).
The change correctly expands the list of PCM format options by includingalaw_8000.
813-819: Addition ofalaw_8000audio format option (Hunk 5).
The newalaw_8000entry is added consistently here as well; please ensure all related documentation is updated accordingly.
905-911: Addition ofalaw_8000audio format option (Hunk 6).
This update adds thealaw_8000option to the supported formats – a straightforward and appropriate enhancement.
997-1003: Addition ofalaw_8000audio format option (Hunk 7).
Continuing the enhancements, thealaw_8000format is added. The consistency across sections is commendable.
1114-1120: Addition ofalaw_8000audio format option (Hunk 8).
The inclusion ofalaw_8000here maintains uniform audio format options across the API.
7257-7297: New Endpoint:/v1/convai/batch-calling/submit(Hunk 9).
A new POST endpoint for batch call submissions has been introduced along with its full specification. Please verify that the operationId, header parameters (such asxi-api-key), request body schema reference, and response mappings (includingBatchCallResponse) adhere to the API’s naming conventions and design guidelines.
8024-8081: New Batch Call Response Schemas (Hunk 10).
The new schemasBatchCallResponse,BatchCallStatisticsResponseModel, andBatchCallStatusResponseModelhave been defined to support the batch call endpoint. They appear comprehensive; ensure that any further constraints (e.g., additional field validations) are documented elsewhere if needed.
8497-8509: Addition offile_formatProperty in Audio Isolation Schema (Hunk 11).
The schema now includes thefile_formatproperty with a clear title, enum, description, and example. The nullable flag indicates that this field is optional. Confirm with client requirements if ‘other’ cases should be treated differently.
8517-8529: Addition offile_formatProperty in Agent Creation Schema (Hunk 12).
A newfile_formatproperty is added similarly to Hunk 11. Consistency in description, enum options, and examples is maintained.
9767-9779: Addition offile_formatProperty in Dubbing Resource Schema (Hunk 13).
The schema now includes afile_formatfield with a default value ofother. Ensure this default is intentional and well-communicated to API consumers.
9812-9841: New Schema: Batch Call Submission Request (Hunk 14).
The schemaBody_Submit_a_batch_call_request__v1_convai_batch_calling_submit_posthas been defined with required fields such ascall_name,agent_id,agent_phone_number_id, andrecipients. The inclusion of amaxItemsconstraint for the recipients array is a good measure.
11219-11243: Enhancements in Conversation History Schemas (Hunk 18).
The changes update conversation history models by adding themain_languageproperty (nullable) and integrating theConversationHistoryRagUsageCommonModel. These additions seem to improve the richness of history data. Please double-check that these optional fields are handled correctly by the API consumers.
14364-14378: New Schema: OutboundCallRecipient (Hunk 19).
TheOutboundCallRecipientschema has been added with requiredphone_numberand an optional reference toConversationInitiationClientDataRequest-Input. Validate that the reference is correct and that the naming aligns with your overall schema conventions.
1 participant
Summary by CodeRabbit