Integrasi API

Transkripsi pertama Anda

Transkripsi berlangsung di latar belakang. Pembuatan tugas langsung mengembalikan respons; periksa statusnya hingga hasil siap.

1. 1

   Buat tugas

   Kirim POST /transcripts dengan URL media langsung yang dapat diakses publik. Simpan id yang dikembalikan.

2. 2

   Periksa progresnya

   Periksa GET /transcripts/{id} setiap 15–30 detik hingga status bernilai complete atau error.

3. 3

   Gunakan transkrip Anda

   Baca JSON dari data, atau unduh file dari export_url saat meminta SRT atau VTT.

Status tugas

Anggap status lainnya masih dalam proses. Status perantara baru dapat ditambahkan.

Autentikasi

Kirim kunci API Anda di header Authorization pada setiap permintaan, persis seperti yang ditampilkan saat Anda membuatnya.

Authorization: <your api key>

Jangan tambahkan awalan Bearer.

Kunci baru diawali dengan tp_live_. Kunci lengkap hanya ditampilkan sekali, saat Anda membuatnya. Jika hilang, cabut kunci tersebut dan buat yang baru; kunci yang dicabut langsung berhenti berfungsi.

Diperlukan langganan aktif dan kunci API dengan izin yang sesuai.

Buat transkrip

Mulai tugas transkripsi untuk file media di URL publik. Respons dikembalikan setelah tugas masuk antrean, dengan status: "initializing".

Taption mengunduh file secara langsung. Tautan halaman berbagi, seperti halaman pratinjau Google Drive atau Dropbox, tidak dapat digunakan.

media_urlstringwajib

Tautan unduhan langsung ke file media Anda.

Maksimal 2048 karakter

extensionstringwajib

Format file media.

mp3wavm4aaacflacwmaopusmp4

languagestringwajib

Bahasa yang digunakan dalam media, dalam bentuk tag bahasa. Lihat referensi Bahasa.

Lihat tag bahasa

namestring

Nama tampilan transkrip. Secara default menggunakan nama file di `media_url`. Nama yang lebih panjang dipotong menjadi 200 karakter.

Maksimal 200 karakter

export_typestring

Format keluaran. Default-nya json, yang mengembalikan isi transkrip yang telah diurai di data. srt dan vtt mengembalikan tautan file di export_url.

jsonsrtvtt

Default: json

max_charinteger

Jumlah maksimal karakter per segmen subtitel. Default-nya `16` untuk bahasa Mandarin, Jepang, Korea, dan Kanton, serta `65` untuk bahasa lain. Nilai di luar 1–200 diabaikan dan nilai default digunakan.

1–200

Respons

Ambil transkrip

Ambil status terkini dan hasil transkrip. Periksa setiap 15–30 detik selama tugas berlangsung.

Untuk json atau jika jenis ekspor tidak ditentukan, hasil yang sudah selesai muncul di data. Untuk srt atau vtt, unduh file dari export_url.

idstringwajib

ID transkrip yang dikembalikan oleh POST /transcripts.Maksimal 256 karakter

Respons

Objek transkrip

Permintaan pembuatan dan pemeriksaan status mengembalikan objek JSON. Field-nya menjelaskan tugas dan, saat sudah siap, hasilnya.

idstring

ID transkrip. Gunakan bersama `GET /transcripts/{id}`.

statusstring

Status tugas: `initializing`, `transcribing`, `complete`, atau `error`. Anggap nilai lainnya masih dalam proses.

dataJSON

Ekspor JSON yang telah diurai saat siap untuk json atau jika export_type tidak ditentukan; selain itu, string kosong.

export_urlstring

Tautan unduhan untuk ekspor srt atau vtt. Kosong sampai siap. Tidak disertakan dalam respons status untuk json atau jika export_type tidak ditentukan.

messagestring

Detail tambahan tentang status terkini. Selama `transcribing`, ini dapat menunjukkan tahap progres seperti `ANALYZING` atau `FINALIZING`. Saat `status` adalah `error`, field ini menjelaskan kegagalan. Ditulis untuk dibaca manusia; jangan diurai secara terprogram.

error_codestring

Kode opsional yang dapat dibaca mesin untuk kesalahan batas pengiriman.

limitinteger

Batas akun yang berlaku, disertakan dalam respons HTTP 429.

Kesalahan dan percobaan ulang

Gunakan kode status HTTP untuk menentukan langkah berikutnya. Field message ditulis untuk dibaca manusia; redaksinya dapat berubah.

Respons API menyertakan header X-Request-Id. Sertakan nilainya saat Anda menghubungi dukungan tentang suatu permintaan.