Skip to main content

Update History

This page lists the major update history for AmiVoice API and this manual. Minor updates and fixes are made regularly in addition to those listed here.

Major Functional Update History for AmiVoice API​

AmiVoice API now supports AWS PrivateLink, which allows you to connect within the AWS network without going through the internet. Via an interface endpoint created within your VPC, you can use the speech recognition, user dictionary operation, and API key issuance APIs with the same API key as before. Prior application is required to use this feature.

For details, please see Private Connection (AWS PrivateLink).

2026-08-12: Released the sentiment analysis feature on the Asynchronous HTTP interface v2​

The sentiment analysis feature was previously provided only on v1 of the Asynchronous HTTP interface, but it is now available on v2 of the Asynchronous HTTP interface as well.

The usage, the way parameters are specified, and the overall structure of the response are basically the same between v1 and v2, but the version of the sentiment analysis engine differs, so even when processing the same audio, the values of the sentiment parameters will not be identical. This is due to an update of the sentiment analysis engine, and the definitions of the emotions indicated by the parameters have not changed. Please keep this in mind when migrating from v1 to v2.

Note that on v1 of the Asynchronous HTTP interface, you can continue to use the sentiment analysis feature in parallel with v2 until the end of service.

2026-07-28: Change to MyPage Display (Some Users)​

For accounts created after the MyPage renewal on 2025-06-30, we have switched the Service ID and Service Password that were displayed in the "Connection Information" on MyPage to be hidden. These were provided for use in authentication in the API Key Issuance API, but from now on, please use an API key issued with the "API Key Issuance Feature" enabled on MyPage.

The Service ID and Service Password cannot be changed unless the account is deleted. Therefore, in order to reduce the risk of leaking authentication information, we have stopped displaying them on MyPage.

Note that for accounts created before the MyPage renewal, they continue to be displayed in the "Connection Information". Since they cannot be changed, please handle them with sufficient care.

2026-07-23: Started detecting partial outages of speech recognition engines on the Statuspage through periodically executed automated tests​

Until now, we monitored the speech recognition server logs, automatically detected communication errors between internal servers, and displayed them on the Statuspage as "接続障害" (Connection Failure). However, with this method alone, we could not sufficiently detect cases where clients were unable to obtain speech recognition results due to factors other than internal communication errors.

We have now added an E2E test that periodically sends test audio from outside to each speech recognition engine, in the same way as actual use, and confirms that recognition results can be obtained normally. This has strengthened the automatic detection of partial outages.

If a state in which a speech recognition engine does not return recognition results continues for some reason, that situation is automatically detected and displayed on the Statuspage.

2026-05-28: Release of New Features and Request Parameters​

A feature to obtain language labels for word-level recognition results has been released. This can be enabled with useLid in the request parameter "segmenterProperties".

Additionally, the parameter "confidenceLevel" for specifying the confidence threshold for recognition results, and the parameters "completeTimeout" and "wildcardModelPenalty" specific to the "音声入力_ルール" engine have been added.

Furthermore, existing parameters maxResponseTime and targetResponseTime have been modified to be effective only for real-time speech recognition, while maxDecodingRate and targetDecodingRate are now effective only for batch processing of pre-recorded audio data.

2026-03-02: Updated Client Libraries​

We have released version 1.1.12 of the client libraries, which includes updates to support newly released features of AmiVoice API and newer versions of various programming languages.

2026-02-16: Release of keyword biasing feature for End to End engine​

The Keyword Biasing for End to End Engine has been released. This feature is similar to the "word registration" in the Hybrid engine and makes it easier to recognize words that are difficult to recognize.

Also, with this release, we have decided to refer to both the "word registration" and "keyword biasing" features collectively as "User Dictionary".

Multiple new features related to speech recognition processing have been released, and maxDecodingTime, maxResponseTime, maxDecodingRate, targetResponseTime, targetDecodingRate, recognitionTimeout, and noInputTimeout have been added as request parameters to enable these features.

Additionally, the Retrieving Profile List has been released for the user word registration API.

2025-10-31: "Usage Aggregation Tag" now supports Asynchronous HTTP interface v2​

Usage Aggregation Tags now supports Asynchronous HTTP interface v2, making it available for all interfaces.

2025-10-02: Language labels added to recognition results of multilingual End to End engine​

Language labels indicating the language of words recognized by the engine have been added to the word-level recognition results of the multilingual End to End engine. For details, please see results[0].tokens[].language in Word-level Results.

2025-09-30: Release of new feature "Usage Aggregation Tag"​

Usage Aggregation Tags, which enables obtaining usage by attribute when sharing the same account, has been released. However, this feature is not yet supported for Asynchronous HTTP interface v2.

2025-08-13: Support for Opus audio data stored in WebM container​

AmiVoice API now supports Opus audio data stored in WebM container. For details, please see Audio formats with headers.

2025-06-23: Word Registration API now supports 8k audio​

Word Registration API can now handle operations for 8k audio profiles. For details, please see adf in the "Request Parameters" of each operation description in User Word Registration.

Major Update History for the Manual​

2026-08-04: Published How to Specify Rule Grammar​

We have published how to specify the rule grammar used in speech recognition requests when using the "音声入力_ルール" engine (-a-rule-input-private) available in AmiVoice API Private. Along with this, we have reorganized the structure of the sections that contain information about rule grammar.

Location: How to Specify Grammar Files under Rule Grammar

We have added security-related information for AmiVoice API, including credit card payment information and the division of responsibility.

Location: Service Specifications

2026-07-10: Guidance for Generative AI and Coding Agents Published​

1. Publication of the Index File llms.txt​

We have published llms.txt, an index file for AI that consolidates links and overviews of the main API specifications and various documents. By having an AI agent read this file first, it can access the information it needs by the shortest path.

2. Provision of Markdown Versions of the Documentation​

For all documentation pages, we now support output in a plain Markdown format that is easy for AI to interpret and considerate of token reduction. It can be obtained by either of the following methods.

  • Request by appending .md to the end of each documentation page URL.
  • Request by adding the Accept: text/markdown header to the HTTP request.

3. Addition of Link Headers to Make the Above Content Easy for AI to Discover​

So that AI crawlers and agents can automatically discover these resources, we add a Link header indicating the URL of the corresponding Markdown version and the location of llms.txt to the HTTP headers of ordinary HTML page responses.

4. Guidance on How Developers Can Make Use of These Features​

We have published guidance on how to make use of the AmiVoice API when carrying out development with generative AI and coding agents by utilizing the new features described above.

Location: Development with Generative AI

2026-07-09: Separated the API Reference from the Manual​

The AmiVoice API reference has been separated from the manual so that it can be viewed from a dedicated tab. For the HTTP interface API, we have migrated to a reference automatically generated from an OpenAPI-format specification. This allows you to always check the latest specification, as well as import the specification directly into various development tools.

Location: Reference

2026-06-26: How to Send Authentication Information in HTTP Request Headers with WebSocket Published​

For the WebSocket interface, we have published a method to send the authentication information (API key) by writing it in the HTTP request header when establishing the WebSocket connection, instead of sending it within the s command after the WebSocket connection.

Location: How to Send Authentication Information in HTTP Request Headers

2026-06-12: "Quick Start" for User Dictionary Published​

A quick start guide has been published to allow easy testing of the user dictionary feature.

Location: User Dictionary

2026-06-08: Terms of Service and SLA Pages Opened​

The terms of service and SLA have been newly published in a separate tab of the manual, allowing access to update history and some past versions.

Location: AmiVoice API Terms of Service / SLA

2026-05-08: Information About MyPage Published​

Information about the MyPage of AmiVoice API has been published.

Location: MyPage (Management Page) Operations

2026-04-14: Renamed "APPKEY" to "API Key"​

We have changed the name of the "service authentication key string" required for using AmiVoice API from "APPKEY" to "API Key". We have also unified the term "One-time APPKEY" to "API Key". Additionally, we have added an explanation page about API keys and partially changed the structure of the manual.

Location: API Key and its sub-pages

We have also corrected an error in the manual regarding the error message displayed when using an API key issued with incorrect service ID or service password in the API Key Issuance API reference.

Location: The "Note" section in API Key Issuance

2026-04-03: Published Reference Information for Adjusting Speech Detection Request Parameters​

We have published recommended values for different usage scenarios and examples of adjustments for speech detection-related parameters within the segmenterProperties request parameter.

Location: Recommended values in segmenterProperties, examples of parameter adjustments in Adjusting Speech Detection Parameters

2026-03-24: Published Information on Handling User Dictionary Data​

As an element of AmiVoice API's service specifications, we have published information on handling user dictionary data.

Location: Handling of User Dictionary Data and Logging Options and Data Provision in Service Specifications

2026-03-12: Renewed "Getting Started" Page​

We have renewed the "Getting Started" page and included a quick start guide to make it easier to begin using AmiVoice API. The previous tutorials have been integrated into the usage pages for each interface.

Location: Getting Started (Quick Start)

2026-03-11: Published Service Specification Information​

We have published information about AmiVoice API's service specifications, including security aspects.

Location: Service Specifications

2026-01-08: Added instructions for setting email addresses for failure notifications​

We have added documentation explaining how to set up email addresses for receiving notifications about AmiVoice API failures. Along with this, we have partially changed the structure of the manual.

Location: Setting Up Failure Notification Recipients

Updated sections: "Speaker diarization parameters" in segmenterProperties, Adjusting speaker detection sensitivity in speaker diarization

2025-12-02: Addition of Statuspage information​

Information about Statuspage, which provides information on AmiVoice API outages and delays, has been added.

Added section: Outage and delay information

2025-10-01: Information on Rule Grammar published​

Information about grammar files used with the "音声入力_ルール" engine (-a-rule-input-private) available in AmiVoice API Private has been published.

Location: Rule Grammar

2025-08-13: Information on segmenterProperties published​

Information about parameters related to adjusting speech segment detection in speech recognition within the request parameter segmenterProperties has been published.

Location: "Speech segment detection parameters" in segmenterProperties