▶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 |