▶API 目錄
Votxt OpenAPI 文件
Beta 版本 Votxt OpenAPI 目前處於 Beta 階段。請先在開發環境測試整合,再用於正式環境。
概覽
Votxt OpenAPI 可將音訊與影片轉寫能力整合到應用程式、工作流程與自動化工具中。
你可以上傳檔案或使用外部檔案 URL,接著建立轉寫任務並查詢處理狀態。
任務完成後,可將轉寫文字、字幕與結構化資料匯出為多種格式。
基礎 URL
https://api.votxt.co認證
在請求標頭中傳送 API 金鑰。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 | YouTube |
| /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
- 最大檔案大小: 最大檔案大小:每個檔案 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 |