API 連携

初めての文字起こし

文字起こしはバックグラウンドで実行されます。ジョブ作成の応答はすぐに返るため、結果が準備できるまで状態を確認してください。

1. 1

   ジョブを作成

   直接アクセスできる公開メディア URL を POST /transcripts に送信し、返された id を保存してください。

2. 2

   進捗を確認

   status が complete または error になるまで、15–30 秒ごとに GET /transcripts/{id} をポーリングしてください。

3. 3

   文字起こしを利用

   data から JSON を読み取ります。SRT または VTT を指定した場合は、export_url からダウンロードします。

ジョブの状態

それ以外の状態は処理中として扱ってください。中間状態が追加される場合があります。

認証

すべてのリクエストの Authorization ヘッダーに、作成時に表示されたとおりの API キーを指定してください。

Authorization: <your api key>

Bearer プレフィックスは付けないでください。

新しいキーは tp_live_ で始まります。完全なキーが表示されるのは作成時の一度だけです。紛失した場合は、そのキーを取り消して新しいキーを作成してください。取り消したキーはすぐに使えなくなります。

有効なサブスクリプションと必要な権限を持つ API キーが必要です。

文字起こしを作成

公開 URL のメディアファイルに対して文字起こしジョブを開始します。キューに追加されると、status: "initializing" を含む応答が返ります。

Taption はファイルを直接ダウンロードします。Google Drive や Dropbox のプレビューなど、共有ページへのリンクは使えません。

media_urlstring必須

メディアファイルへの直接ダウンロードリンク。

最大 2048 文字

extensionstring必須

メディアファイルの形式。

mp3wavm4aaacflacwmaopusmp4

languagestring必須

メディアで話されている言語のタグ。言語リファレンスを参照してください。

言語タグを確認

namestring

文字起こしの表示名。既定値は `media_url` 内のファイル名です。長い名前は 200 文字に切り詰められます。

最大 200 文字

export_typestring

出力形式。既定値の json は解析済みの文字起こし内容を data に返します。srt と vtt はファイルリンクを export_url に返します。

jsonsrtvtt

既定値：json

max_charinteger

字幕区間ごとの最大文字数。中国語・日本語・韓国語・広東語は既定で `16`、他の言語は `65` です。1-200 の範囲外の値は無視され、既定値が使われます。

1–200

レスポンス

文字起こしを取得

文字起こしの現在の状態と結果を取得します。処理中は 15–30 秒ごとにポーリングしてください。

json または出力形式を省略した場合、完了した結果は data に含まれます。srt または vtt の場合は export_url からファイルをダウンロードしてください。

idstring必須

POST /transcripts から返された文字起こし ID。最大 256 文字

レスポンス

文字起こしオブジェクト

作成と状態取得のリクエストは JSON オブジェクトを返します。各フィールドはジョブの情報と、準備ができた時点での出力を示します。

idstring

文字起こし ID。`GET /transcripts/{id}` と組み合わせて使用します。

statusstring

ジョブの状態：`initializing`、`transcribing`、`complete`、`error`。それ以外は処理中として扱ってください。

dataJSON

json または export_type を省略した場合に、準備が整うと解析済み JSON が返されます。それまでは空文字列です。

export_urlstring

srt または vtt 出力へのダウンロードリンク。準備ができるまでは空です。json または export_type 省略時の状態応答には含まれません。

messagestring

現在の状態の補足情報。`transcribing` 中は `ANALYZING` や `FINALIZING` などの進捗段階になることがあります。`status` が `error` のときは失敗の内容を示します。人が読むための情報なので、プログラムで解析しないでください。

error_codestring

送信制限エラーを示す、省略可能な機械可読コード。

limitinteger

HTTP 429 に含まれる、適用されたアカウントの上限値。

エラーと再試行

HTTP ステータスコードを基に次の処理を判断してください。message は人が読むためのフィールドであり、文言は変更されることがあります。

API の応答には X-Request-Id ヘッダーが含まれます。リクエストについてサポートに問い合わせる際は、この値をお知らせください。