🌿 ✨ [Scheduled] Update API Spec #176
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Several changes were made to the API, including the addition of a new object, modifications to existing objects, and updates to the maximum lengths of certain fields.
Added
BackoffPlanto define the backoff strategy for request retries.mipOptOutfield toServer,VoiceProviderTwilio, andVoiceProviderVonageobjects to opt out of the Deepgram Model Improvement Partnership Program.regex,value, andtargetfields to thePropertyobject for data validation and value filling.swap-system-message-in-history-and-remove-transfer-tool-messagesas a new option for thetransferModefield in theTransferobject.deepseek-r1-distill-llama-70bas a new model option in theVoiceProviderDeepgramobject.metadatafield to theEdgeobject for storing additional data.numberandnumberDesiredAreaCodefields to thePhoneNumberobject for specifying phone number details.ChatCompletionMessageMetadata,ChatCompletionMessage, andChatCompletionsDTOobjects for handling chat completion messages.topKfield to theTrieveKnowledgeBaseSearchPlanobject to specify the number of top chunks to return.AnthropicCredential,AnyscaleCredential,AssemblyAICredential, andChatCompletionMessageobjects for managing credentials and chat completion messages.acknowledgementPhrases,interruptionPhrases, andsilenceTimeoutMessagefields to theAssistantobject for configuring assistant behavior.Removed
BuyPhoneNumberDTOobject and related fields fromUpdatePhoneNumberDTOandCreatePhoneNumberDTO.ToolCallobject and related fields fromCreateWorkflowDTOandUpdateWorkflowDTO.Changed
namefield in various objects, includingEdge,Server,VoiceProviderTwilio,VoiceProviderVonage,PhoneNumber, andAssistant.transferModefield in theTransferobject to include a new option.concurrencyLimitIncludedfield in theSubscriptionobject to include a minimum value of 1.minutesIncludedandminutesUsedfields in theSubscriptionobject to include a minimum value of 1.outboundCallsDailyLimitandoutboundCallsCounterfields in theSubscriptionobject to 1.