Getting started

Quickstart

一つの長尺動画を送信し、非同期Jobを待ち、3本のClipと投稿素材を取得するまでの設計です。

Before you start

Preview data

以下のURL、ID、レスポンスはUI確認用です。実行可能なAPIではありません。

1
認証情報を安全に読み込む
将来のAPIキーはサーバー側の環境変数から読み込み、ブラウザへ露出させません。
Terminalexport VIRAFY_API_KEY=preview_key_not_available
2
Sourceを作成する
日本語の28分42秒の動画をURLで登録し、src_preview_01を受け取ります。
RequestPOST https://api.virafy.example/v1/sources
3
Jobを作成する
縦型、字幕付き、3候補という出力条件でjob_preview_01を作成します。
RequestPOST https://api.virafy.example/v1/jobs
4
完了を待つ
queued、analyzing、generating、succeededの順に状態を確認します。
RequestGET https://api.virafy.example/v1/jobs/job_preview_01
5
結果を取得する
3本のClipと、MP4・SRT・サムネイルのAssetを取得します。
RequestGET https://api.virafy.example/v1/clips?job_id=job_preview_01