▶API 目次
Votxt OpenAPI ドキュメント
ベータ Votxt OpenAPI は現在ベータ版です。本番利用前に開発環境で統合をテストしてください。
概要
Votxt OpenAPI で、音声と動画の文字起こしをアプリや自動化ワークフローに組み込めます。
ファイルをアップロードするか外部ファイル URL を使い、文字起こしタスクを作成して状態を確認します。
完了後は、文字起こし、字幕、構造化データを複数の形式でエクスポートできます。
ベース URL
https://api.votxt.co認証
リクエストヘッダーに API キーを送信します。API アクセスには対応する有効なプランが必要です。
X-API-Key: your_api_key_here- アカウント設定を開きます。
- プランに API アクセスが含まれていることを確認します。
- API キーを作成し、安全に保存します。
ファイルアップロード
署名付き URL の直接アップロード、または公開された外部ファイル URL を使用できます。
POST /api/v1/files/upload-urlPUT upload_urlPOST /api/v1/transcriptions
POST /api/v1/files/upload-url
Content-Type: application/json
X-API-Key: your_api_key
{
"filename": "audio.mp3",
"file_size": 1048576,
"upload_expires_in": 3600,
"download_expires_in": 1800
}文字起こし
| エンドポイント | メソッド | 説明 |
|---|---|---|
| /api/v1/transcriptions | POST | ファイルアップロード |
| /api/v1/transcriptions/youtube | POST | 動画リンク |
| /api/v1/transcriptions | GET | 文字起こし |
| /api/v1/transcriptions/{id} | GET | 文字起こし編集 |
| /api/v1/transcriptions/{id}/status | GET | 状態 |
POST /api/v1/transcriptions
Content-Type: application/json
X-API-Key: your_api_key
{
"file_key": "12345-abc123def456.mp3",
"filename": "audio.mp3",
"language_code": "en",
"transcription_type": "transcript",
"enable_speaker_diarization": false,
"webhook_url": "https://your-app.com/webhook"
}状態
| 状態 | 文字起こし |
|---|---|
| queued | 待機中 |
| preprocessing | 前処理中 |
| processing | 処理中 |
| completed | 完了 |
| failed | 失敗 |
エクスポート
完了後は、文字起こし、字幕、構造化データを複数の形式でエクスポートできます。
| エクスポート | 形式 |
|---|---|
| エクスポート | TXT |
| エクスポート | SRT |
| エクスポート | VTT |
| エクスポート | JSON |
| エクスポート | MD |
| エクスポート | CSV |
| エクスポート | DOCX |
| エクスポート |
形式
- 音声形式: mp3, mpeg, mpga, m4a, wav, aac, ogg, opus, flac
- 動画形式: mp4, webm, mov
- 最大ファイルサイズ: 最大ファイルサイズ：1ファイル5GB
言語
Votxt は多くの文字起こし言語に対応しています。リクエストに言語コードを渡してください。
| 言語 | コード | 言語 | コード | 言語 | コード |
|---|---|---|---|---|---|
| Afrikaans | af | Gujarati (ગુજરાતી) | gu | Polish (Polski) | pl |
| Arabic (العربية) | ar | Hebrew (עברית) | he | Portuguese (Português) | pt |
| Azerbaijani (Azərbaycan) | az | Hindi (हिन्दी) | hi | Romanian (Română) | ro |
| Belarusian (Беларуская) | be | Croatian (Hrvatski) | hr | Russian (Русский) | ru |
| Bulgarian (Български) | bg | Haitian Creole (Kreyòl ayisyen) | ht | Slovak (Slovenčina) | sk |
| Bengali (বাংলা) | bn | Hungarian (Magyar) | hu | Slovenian (Slovenščina) | sl |
| Bosnian (Bosanski) | bs | Indonesian (Bahasa Indonesia) | id | Albanian (Shqip) | sq |
| Catalan (Català) | ca | Italian (Italiano) | it | Serbian (Српски) | sr |
| Czech (Čeština) | cs | Japanese (日本語) | ja | Swedish (Svenska) | sv |
| Welsh (Cymraeg) | cy | Kazakh (Қазақ) | kk | Swahili (Kiswahili) | sw |
| Danish (Dansk) | da | Kannada (ಕನ್ನಡ) | kn | Tamil (தமிழ்) | ta |
| German (Deutsch) | de | Korean (한국어) | ko | Telugu (తెలుగు) | te |
| Greek (Ελληνικά) | el | Lithuanian (Lietuvių) | lt | Thai (ไทย) | th |
| English | en | Latvian (Latviešu) | lv | Tagalog (Tagalog/Filipino) | tl |
| Spanish (Español) | es | Macedonian (Македонски) | mk | Turkish (Türkçe) | tr |
| Estonian (Eesti) | et | Malayalam (മലയാളം) | ml | Ukrainian (Українська) | uk |
| Basque (Euskara) | eu | Marathi (मराठी) | mr | Urdu (اردو) | ur |
| Persian (فارسی) | fa | Malay (Bahasa Melayu) | ms | Vietnamese (Tiếng Việt) | vi |
| Finnish (Suomi) | fi | Dutch (Nederlands) | nl | Chinese (Cantonese) (粵語) | yue |
| French (Français) | fr | Norwegian (Norsk) | no | Chinese (Simplified) (中文 简体) | zh |
| Galician (Galego) | gl | Punjabi (ਪੰਜਾਬੀ) | pa | Chinese (Taiwanese Mandarin) (國語) | zh_tw |