--- slug: /amivoice-api/manual/getting-started --- AmiVoice API は音声をテキストに変換する音声認識APIです。音声を送信すると、発話内容をテキストにした結果を返します。会議の文字起こしや音声対話システムなどの音声対応アプリケーションを作成できます。 ![図. AmiVoice API の概要](/img/amivoice-api/manual/amivoice-api-overview4.drawio.svg "図. AmiVoice API の概要") ## ドキュメンテーションの構成 導入前のセキュリティや運用のための情報は「導入・運用ガイド」、実装の詳細は「開発ガイド」、API仕様の確認は「リファレンス」、お困りの際は「ヘルプ」のセクションを参照してください。 ## クイックスタート {#quick-start} [アカウント作成ページ](https://acp.amivoice.com/amivoice_api/regist/)からアカウントを作成し、マイページの［接続情報］に表示される **API キー** を控えてください。次のコマンドで環境変数に設定します。 **macOS / Linux** ```bash export API_KEY=your_api_key_here ``` **Windows (PowerShell)** ```powershell $env:API_KEY = "your_api_key_here" ``` **Windows (コマンドプロンプト)** ```bat set API_KEY=your_api_key_here ``` **Tip** AmiVoice Tech Blogでは、アカウントを作成し、サンプルプログラムを使って実際に自分の音声で認識結果を表示してみるところまでステップバイステップで手順を説明していますので、こちらを参照してください。 [音声認識API「AmiVoice API」を使ってみよう](https://acp.amivoice.com/blog/trial_amivoice_api/) 書き起こしたい音声ファイルを用意します。以下のサンプル音声（**test.wav**）をそのまま使えます。 {() => { const WaveSurferPlayer = require('@site/src/components/Custom/WaveSurferPlayer').default; return ; }} 対応している音声ファイルの形式については[音声フォーマットについて](/amivoice-api/manual/audio-format)を参照してください。 以下を実行してください。`test.wav` を使用する音声ファイルのパスに置き換えてください。 **curl (macOS / Linux)** ```bash curl https://acp-api.amivoice.com/v1/recognize \ -F d=-a-general \ -F u=$API_KEY \ -F a=@test.wav | jq ``` **Note** - `curl`コマンドがインストールされていない場合、https://curl.se/ からご利用の OS のパッケージをダウンロードするか、パッケージマネージャを利用してcurlをインストールしてください。 - [結果テキスト](/amivoice-api/manual/result-format#%E7%B5%90%E6%9E%9C%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)はUnicodeエスケープされています。上記コマンドでは、レスポンスを見やすく整形するために`jq`を使用しています。`jq`がインストールされていない場合は、`| jq`の部分を除いて実行してみてください。`jq`コマンドは、https://stedolan.github.io/jq/ からご利用の OS のパッケージをダウンロードするか、パッケージマネージャを利用してインストールできます。 **curl (Windows PowerShell)** ```powershell curl.exe https://acp-api.amivoice.com/v1/recognize ` -F d=-a-general ` -F u=$env:API_KEY ` -F a=@test.wav | jq ``` **Note** - PowerShell では `curl` は `Invoke-WebRequest` の別名になっているため、`curl.exe` と明示してください。Windows 10 バージョン 1803 以降には `curl.exe` が標準で含まれています。含まれていない場合は https://curl.se/ からインストールしてください。 - [結果テキスト](/amivoice-api/manual/result-format#%E7%B5%90%E6%9E%9C%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)はUnicodeエスケープされています。上記コマンドでは、レスポンスを見やすく整形するために`jq`を使用しています。`jq`がインストールされていない場合は、`| jq`の部分を除いて実行してみてください。`jq`コマンドは、https://stedolan.github.io/jq/ からご利用の OS のパッケージをダウンロードするか、パッケージマネージャを利用してインストールできます。 **curl (Windows コマンドプロンプト)** ```bat curl https://acp-api.amivoice.com/v1/recognize ^ -F d=-a-general ^ -F u=%API_KEY% ^ -F a=@test.wav ``` **Note** - Windows 10 バージョン 1803 以降には `curl` が標準で含まれています。含まれていない場合は https://curl.se/ からインストールしてください。 - [結果テキスト](/amivoice-api/manual/result-format#%E7%B5%90%E6%9E%9C%E3%83%86%E3%82%AD%E3%82%B9%E3%83%88%E3%81%AB%E3%81%A4%E3%81%84%E3%81%A6)はUnicodeエスケープされています。上記コマンドでは、レスポンスを見やすく整形するために`jq`を使用しています。`jq`がインストールされていない場合は、`| jq`の部分を除いて実行してみてください。`jq`コマンドは、https://stedolan.github.io/jq/ からご利用の OS のパッケージをダウンロードするか、パッケージマネージャを利用してインストールできます。 **Python** ```python import os import requests with open("test.wav", "rb") as f: response = requests.post( "https://acp-api.amivoice.com/v1/recognize", data={"d": "-a-general", "u": os.environ["API_KEY"]}, files={"a": f} ) data = response.json() # JSON パーサーが Unicode エスケープを自動的に日本語に変換します print(data) ``` 成功すると以下のような JSON が返ります。`text` フィールドに書き起こし結果が含まれます。 ```json { "results": [ { "tokens": [ ... ], "confidence": 0.998, "starttime": 250, "endtime": 8794, "text": "アドバンスト・メディアは、人と機械との自然なコミュニケーションを実現し、豊かな未来を創造していくことを目指します。" } ], "utteranceid": "20220602/14/018122d637320a301bc194c9_20220602_141433", "text": "アドバンスト・メディアは、人と機械との自然なコミュニケーションを実現し、豊かな未来を創造していくことを目指します。", "code": "", "message": "" } ``` 詳細なレスポンスの内容については[音声認識の結果](/amivoice-api/manual/result-format)を参照してください。 ## 次のステップ クイックスタートは、同期 HTTP インタフェースを使いました。リアルタイム音源を扱いたい場合はWebSocket インタフェース、16MBを超える大きな音声ファイルを処理したい場合は非同期HTTPインタフェースが利用できます。それぞれのユースケースや使い分けのポイントについては、[インタフェースの種類と使い方](/amivoice-api/manual/interfaces)を参照してください。 開発をサポートするクライアントライブラリやサンプルプログラムも提供しています。生成 AI やコーディングエージェントを使って調査や実装を進めたい場合は、[生成AIを利用した開発](/amivoice-api/manual/development-with-generative-ai)を参照してください。 音声認識精度の改善のためのカスタマイズについては、以下の機能を活用できます。 話者ダイアライゼーションや感情分析などの追加機能も提供しています。目的に応じて活用してください。 構築したサービスの運用をサポートする機能についても提供しています。 包括的な[開発ガイド](/amivoice-api/manual/user-guide)も参照してください。