ReelaDocs

自動化

Reela CLIの完了通知サブスクリプションを通じて動画を作成し、完成した動画をワークフローに接続します。

Reela CLIの完了通知サブスクリプションを通じて動画を作成し、完成した動画をワークフローに接続します。

Reelaには動画制作のコマンドと、完成した動画の完了通知サブスクリプションが用意されています。エージェントやその他のツールから概要を送信し、Reelaのウェブサイトを開いたままにすることなく、CLIデーモンを通じて出力を受け取れます。

概要から動画を作成する

createは、テキストの概要と任意のメディアを動画タスクに変換します。プロンプトを直接入力するか、ファイルから読み込むことができます。また、長さやレイアウトを選択し、アバターを含めたり、参照画像、映像素材、BGMを添付したりできます。

reela create --prompt-file brief.txt \
  --visual ai-video --layout portrait --duration 30 \
  --session "Product campaign" --output json

動画の生成には時間がかかります。送信する前にデーモンを起動し、完了通知サブスクリプションを設定してください。Reelaはバックグラウンドで動画を生成し、完成した結果をスクリプトに配信します。セッションタイトルを再利用すると、関連する動画が1つのプロジェクトにまとめられます。設定については、以下の自動配信を参照してください。

送信前に--dry-runを追加すると、ファイルをアップロードしたりタスクを作成したりすることなく、リクエストを検証し、推定クレジットを確認できます。タスクを送信するとクレジットを消費する場合があります。

対応するビジュアルとメディア入力については、動画作成オプションを参照してください。

ティアで画質とコストを選択する

ティアを使うと、リクエストごとに生成オプションを選択できます。Reelaは、希望する結果に合わせてあなたやエージェントがオプションを選べるよう、説明を提示し、送信前にそのリクエストのクレジットを見積もります。

reela tiers list
reela tiers list --output json

一覧には各ティアのラベルと説明が表示され、デフォルトも示されます。JSON出力では、tiersにlabel、content、is_defaultを含むエントリが格納され、default_tierにデフォルトが示されます。一覧内の位置ではなく、各オプションの内容を理解するためにcontentを読んでください。ティアを一覧表示しても、アカウントですべてのオプションを利用できるとは限りません。Reelaはリクエストの検証時または送信時にアクセス権を確認します。

--tierには正確なラベルを渡します。以下の<tier-label>を一覧にあるラベルに置き換えてください。ラベルにスペースが含まれる場合は引用符を残してください。

reela create --prompt-file brief.txt --visual ai-video \
  --tier "<tier-label>" --duration 30 --layout portrait \
  --dry-run --output json

プレビューにはcredits_costとquota_afterが返されます。送信するには--dry-runを削除し、選択したティアとその他のオプションはそのままにします。ティアは生成オプションを表すものです。実際のリクエストのコスト見積もりにはプレビューを使用してください。

--tierを省略すると、ReelaはCLIで現在利用できるデフォルトを使用します。デフォルトが利用できない場合は、reela tiers listを実行して選択肢を更新するか、ティアを明示的に指定してください。ティアを明示的に選択すると、デフォルトが変更されてもワークフローの選択を維持できます。ただし、利用状況や価格は変わる場合があります。一覧表示、プレビュー、送信には同じプロファイルを使用してください。

出力の詳細と選択時の動作については、tiersコマンドのリファレンスを参照してください。

エージェントやツール向けの構造化された結果

--output jsonを使うと、ティアの選択肢、クレジットの見積もり、送信確認など、コマンドの結果を構造化データとして利用できます。終了コード0はコマンドの成功を意味します。エラーにはJSONモードでもゼロ以外の終了コードが使われ、標準エラー出力にはプレーンテキストが出力されます。

送信が成功すると、デーモンが完了までの待機を処理し、結果を添えて登録済みのスクリプトを呼び出します。送信応答と完了イベントにはtask_idが含まれるため、ワークフローで完成した動画を元の概要と関連付けることができます。

自動配信

Reela CLIは、動画タスクの完了時に独自の実行ファイルを実行できます。この完了通知サブスクリプションにより、動画を公開ツールに渡す、レコードを更新する、別のシステムに通知するといった次の処理にReelaの出力をつなげられます。Reelaは完了を監視し、タスクの詳細をスクリプトに渡します。

スクリプトを登録する

Reela CLIを実行しているマシン上の実行ファイルへの絶対パスを指定してください。イベントを標準入力から読み取り、終了コードで成功を示す限り、どの言語でも使用できます。

reela subscribe add script --path /absolute/path/on-video \
  --timeout-seconds 300 --max-retries 3

各プロファイルに登録できるスクリプトサブスクリプションは1つです。既存のサブスクリプションの実行ファイルを変更するには、reela config set delivery.script.path /absolute/path/on-videoを使用します。以下の説明に従い、サブスクリプションまたはその設定を変更した後は、すでに実行中のデーモンを再起動してください。

完了イベントを受け取る

Reelaは実行ファイルを起動し、JSONオブジェクトを1つ標準入力に書き込みます。

{
  "event": "task.completed",
  "task_id": "12345",
  "status": "completed",
  "status_label": "completed",
  "title": "Product demo",
  "description": "A short product introduction",
  "download": {
    "filename": "product-demo.mp4",
    "download_url": "https://example.com/video.mp4"
  }
}

task_idを使用して、イベントを元の送信リクエストに関連付けてください。title、description、downloadはnullの場合があります。存在する場合、downloadには完成した動画の推奨ファイル名とダウンロードURLが含まれ、スクリプトで直接利用できます。動画を必要とする処理を実行する前に、downloadの値がない場合に対処してください。

署名付きdownload_urlリンクの有効期限は、生成から6時間後です。完了イベントを受け取ったら、速やかに動画をダウンロードするか、自分のストレージにコピーしてください。ダウンロードURLは非公開に保ち、恒久的な動画アドレスではなく、一時的なアクセスリンクとして扱ってください。

サブスクリプションは、CLI以外で作成された動画を含め、選択したアカウントの完了済みタスクを受信します。特定のワークフローに処理を関連付ける場合は、イベントのタスクIDを送信したタスクと照合してください。完了通知サブスクリプションが現在処理するのは正常に完了したタスクのみです。失敗、キャンセル、一部のみ完了したタスクでは、このイベントは発生しません。

実行と再試行

  • 成功: 処理が成功したら0で終了します。Reelaはスクリプトの標準出力を破棄し、出力された内容を結果として使用しません。
  • タイムアウト: --timeout-seconds 300では、各呼び出しに最大300秒が許可されます。タイムアウトまたはゼロ以外の終了コードは配信失敗となります。
  • 再試行: Reelaは配信に失敗すると再試行します。スクリプト方式のみが失敗した場合、--max-retries 3では初回を含めて合計3回まで試行できます。他の有効な方式も関係する失敗にはdelivery.max_retriesが適用されます。
  • 再配信: 同じtask_idに対して処理を繰り返しても問題がないようにしてください。これにより、再度呼び出されても同じ動画を再公開したり、同じレコードを二重に追加したりすることを防げます。

サブスクリプションを実行し続ける

CLIデーモンは完了イベントを処理し、有効になっている配信方式を実行します。方式を選択したら、デーモンを起動し、配信状況を確認してください。

reela daemon start
reela subscribe status

方式を追加すると、停止中のデーモンの起動も試みます。すでに実行中の場合は、配信設定を変更した後に再起動して、変更を適用してください。手動で起動したデーモンの場合は、reela daemon stopに続けてreela daemon startを使用してください。

Reelaは配信の進行状況を保存し、デーモンの再起動時にそこから再開します。進行状況が保存されていない場合は、デフォルトで新しいイベントを追跡します。reela daemon start --keep-backlogは、進行状況が保存されていない場合に、引き続き利用可能な過去の完了済みタスクのイベントも処理します。

reela daemon installを使うと、サインイン時に起動するよう設定できます。サービスとしてインストールされている場合は、設定変更後にオペレーティングシステムのサービスマネージャーから再起動してください。reela daemon statusまたはreela daemon logs --tail 50を確認して配信状況を調べてください。

自動配信を利用するには、デーモンを実行するマシンの電源が入ったまま、ネットワークに接続されている必要があります。完了時にスクリプトを実行する動画を送信する前に、デーモンを起動してください。

daemonとsubscribeはLinuxとmacOSで利用できます。Windows x64では、動画コマンド、ステータス照会、手動ダウンロードに対応しています。

任意のダウンロードとメール配信

スクリプトと併せて、自動ダウンロードや動画完成時のメール通知を有効にできます。デフォルトの配信設定ではダウンロードが有効です。保存先はreela config set delivery.download ~/Videos/reelaで設定します。無効になっている場合は、reela subscribe add download --dir ~/Videos/reelaで有効にしてください。メール通知はreela subscribe add emailで有効にします。必要に応じて--address me@example.comを追加すると、アカウントのメールアドレス以外のアドレスを使用できます。

複数の方式を同時に有効にできます。また、ある方式に失敗しても、他の方式の実行は妨げられません。スクリプト呼び出しごとに、利用可能な場合はダウンロード情報を含む独自の完了ペイロードが渡されます。すべての方式については、配信コマンドのリファレンスを参照してください。

制作環境を再利用する

Reelaには、ワークフローのステップとして利用できる追加機能があります。

  • 一貫したブランディング: brand listで既存のブランドパッケージを一覧表示し、brand applyでタスクに適用します。このコマンドはブランド適用後の出力ができるまで待機します。ブランドコマンドを参照してください。
  • プログラムによる編集: 編集JSONをダウンロードし、変更を検証し、プレビュー用の下書きを保存してから、editでレンダリングを送信します。編集コマンドを参照してください。
  • アカウントと設定の分離: --profileまたはREELA_PROFILEでプロファイルを選択します。配信方式と設定は、選択したプロファイルに適用されます。プロファイルと設定を参照してください。

たとえば、商品動画のワークフローでは、参照画像を添えて概要を送信し、デーモンの完了通知サブスクリプションを使って完成した動画を公開ツールに渡すことができます。Reelaはバックグラウンドでの生成と完了時の配信を担います。送信のタイミングと、結果を受け取ったときの処理は、使用するツールで選択します。

すべてのサブスクリプションとデーモンのオプションについては、配信コマンドのリファレンスを参照してください。インストールとアカウント認証については、はじめにから始めてください。