|
| 1 | +## [3.0.0] - 2026-10-09 |
| 2 | +### Breaking Changes |
| 3 | +- **`Call.phoneNumber`** — type changed from `ImportTwilioPhoneNumberDto` to `TransientTwilioPhoneNumber`; update any code that constructs or reads this field to use `TransientTwilioPhoneNumber` instead. |
| 4 | + |
| 5 | +### Added |
| 6 | +- **`AssemblyAiTranscriberSpeechModel.Universal36Pro`** and **`FallbackAssemblyAiTranscriberSpeechModel.Universal36Pro`** — new `universal-3-6-pro` speech model option for AssemblyAI transcribers. |
| 7 | +- **`agentContextAutoUpdateEnabled`** — new optional field on `AssemblyAiTranscriber` and `FallbackAssemblyAiTranscriber` that automatically sends the assistant's last spoken text as `agent_context` after each turn. |
| 8 | +- **`DeepgramVoiceModel.Flux`** / **`FallbackDeepgramVoiceModel.Flux`** — new Flux model option for Deepgram voices, with accompanying optional `speed` and `expressivity` fields on `DeepgramVoice` and `FallbackDeepgramVoice`. |
| 9 | +- **`squadVersion`** — new optional field on `Call` and `AssistantActivation` exposing the squad version governing the call or activation. |
| 10 | + |
| 11 | +### Added |
| 12 | +- **`VapiClient.trafficAllocations`** — new `TrafficAllocationsClient` accessor for managing traffic allocation resources, exported via the `./trafficAllocations` package entry point. |
| 13 | +- **`OpenAiModel.speaker`**, **`OpenAiModel.reasoner`**, and **`OpenAiModel.serviceTier`** — new optional fields for configuring GPT-Live speaker, reasoner, and OpenAI service tier (fast/auto/default) on `OpenAiModel`. |
| 14 | +- **`ForbiddenError`** — new exported error class (HTTP 403) added to the errors surface. |
| 15 | +- **`RimeAiVoiceIdEnum`** and **`FallbackRimeAiVoiceIdEnum`** — seven new voice values added: `Clementine`, `Walnut`, `Eyre`, `Bancroft`, `Hesse`, `Beatty`, and `Godfrey`, covering the new mistv3 and coda Rime AI models. |
| 16 | +- **`UserMessage.confidence`** and **`UserMessage.confidenceSource`** — new optional fields exposing the transcriber's confidence score and its origin (`"provider"` or `"derived"`); `UserMessage.metadata` type narrowed to `UserMessageMetadata`. |
| 17 | + |
| 18 | +### Changed |
| 19 | +- **`SimulationRunItemResults`** — adds optional `latencyEvaluations` field and updates `passed` to reflect latency expectations in addition to structured output evaluations. |
| 20 | +- **`CreateCallDto.squadVersion`** — new optional field for pinning a specific squad version on a call. |
| 21 | +- **`OpenAiVoiceId`** / **`FallbackOpenAiVoiceId`** — voice availability documentation updated to reflect new GPT-Live-only voices (quartz, ripple, vesper, willow, stone, gleam, meridian, bossa, tempo, beacon, delta, cinder). |
| 22 | + |
| 23 | +### Added |
| 24 | +- **`TrafficAllocationsClient`** — new beta client (`client.trafficAllocations`) for managing assistant traffic splitting, with methods to list allocation history, create a new allocation, retrieve the latest allocation, and fetch a single allocation by ID. |
| 25 | +- **`modelDeprecations`** — new optional read-only field on **`Assistant`**, **`AssistantDraft`**, and **`AssistantVersion`** that surfaces deprecation and retirement notices for any models in use, including replacement recommendations. |
| 26 | +- **`ClientInboundMessageAppendContext`** and **`ClientInboundMessageAppendContextKind`** — new types enabling callers to append commentary, thinking, or instructions to an in-progress call via the `append-context` message variant on `ClientInboundMessageMessage`. |
| 27 | +- **New enum values** added to `CallEndedReason` (e.g. `CallStartSquadVersionErrorValidation`, `SipOutboundUnallocatedNumber`), `AssemblyAiTranscriberLanguageCodesItem` (13 new language codes), and `AnthropicBedrockModelFallbackModelsItem` (new Claude model variants). |
| 28 | +- **`AudioFormatFormat`** — new exported enum type representing supported audio formats (`pcm_s16le`, `mulaw`). |
| 29 | + |
| 30 | +### Added |
| 31 | +- **`OpenAiReasoner`** and **`OpenAiSpeaker`** — new types for configuring GPT-Live real-time voice, including `gpt-live-1` and `gpt-6-luna` model values on `OpenAiModelModel`, and a new `OpenAiModelServiceTier` enum for fast/priority processing tiers. |
| 32 | +- **`LatencyExpectation`** and **`LatencyEvaluationResult`** — new types for simulation latency testing; `CreateScenarioDto` gains an optional `latencyExpectations` field to set per-metric ceilings (turn, model, voice) with configurable aggregation (mean, median, p95, max). |
| 33 | +- **`CreateTrafficAllocationTargetDto`**, **`GetTrafficAllocationLatestDto`**, and **`GetTrafficAllocationPaginatedDto`** — new types supporting assistant traffic splitting across published versions. |
| 34 | +- **`ClientMessageTranscript.confidence`** and **`ClientMessageTranscript.confidenceSource`** — new optional fields exposing the transcriber's confidence score and its origin (`provider` or `derived`), backed by the new `ClientMessageTranscriptConfidenceSource` enum. |
| 35 | +- **New enum values** across `DeepgramVoiceId` (36 voices), `FallbackDeepgramVoiceId` (36 voices), `FallbackOpenAiVoiceIdEnum` (17 voices), `ElevenLabsVoiceModel` / `FallbackElevenLabsVoiceModel` (`eleven_v4_turbo`), `FallbackRimeAiVoiceModel` (`coda`, `mistv3`), `FallbackAssemblyAiTranscriberLanguageCodesItem` (14 language codes), and `InviteUserDtoRoleZero` (`hipaa-special`). |
| 36 | + |
| 37 | +### Added |
| 38 | +- **`TransientTwilioPhoneNumberFallbackDestination`** — new discriminated union type (`number` | `sip`) representing the fallback destination for inbound transient Twilio phone number calls. |
| 39 | +- **`TransientTwilioPhoneNumberHooksItem`** — new discriminated union type (`call.ringing` | `call.ending`) for lifecycle hooks on transient Twilio phone numbers. |
| 40 | +- **`UserMessageConfidenceSource`** — new enum (`"provider"` | `"derived"`) indicating whether a transcription confidence score came from the provider or was computed by Vapi. |
| 41 | +- **`UserMessageMetadata`** — new interface exposing word-level confidence scores and out-of-band message metadata on user messages. |
| 42 | +- **New enum values** added: `HipaaSpecial` to `UpdateUserRoleDtoRoleZero`, `SquadVersion` to `VersionPinReferenceSourceType`, and `Gpt6Luna` to `WorkflowOpenAiModelModel`. |
| 43 | + |
1 | 44 | ## [2.0.1] - 2026-08-26 |
2 | 45 |
|
3 | 46 | ## 2.0.0 - 2026-06-24 |
|
0 commit comments