CLI

orc creative

orc creative は、Creative API(/v1/creative)をターミナルから呼び出すコマンドです。画像、動画、音声を生成し、ジョブの状態と成果物を確認できます。CI やスクリプトからも、同じコマンドで生成を実行できます。

インストール

terminal
curl -fsSL https://orchestor.io/install | sh

Windows と npm でのインストールはインストールを参照してください。

クイックスタート

サインインします。

terminal
orc auth login

画像を生成し、完了まで待って成果物を表示します。

terminal
orc creative image generate --model gpt-image-2 --prompt "白い背景の赤い立方体" --wait

CI やスクリプトでは、API キーを ORCHESTOR_API_KEY に設定します。API キーは保存済みのサインインより優先されます。ブラウザのダッシュボードセッションは /v1/creative では使えません。

terminal
export ORCHESTOR_API_KEY="<API キー>"

生成の流れ

生成は非同期のジョブです。

  1. orc creative image models list などでモデルを選びます。
  2. image generate、video generate、tts generate、voice change でジョブを作成します。同じ入力を安全に再送するときは --idempotency-key を付けます。
  3. --wait を付けると、ジョブが COMPLETED、FAILED、CANCELED のいずれかになるまで待ち、完了したら成果物を表示します。--timeout と --poll-interval で待ち方を調整できます。
  4. --wait を付けない場合は、orc creative jobs status <id> で状態を、orc creative jobs result <id> で成果物を取得します。完了を --webhook-url で受け取ることもできます。

手元のファイルを入力に使うときは、orc creative files upload-url create でアップロード先を発行し、返された公開 URL を入力に指定します。

コマンド

コマンド内容
orc creative image画像モデルの確認と画像生成
orc creative video動画モデルの確認と動画生成
orc creative tts音声合成のモデルと声の確認、音声生成
orc creative voice音声や動画の声の変換
orc creative jobsジョブの状態、成果物、履歴の確認と取り消し
orc creative files入力ファイルのアップロード先の発行
orc creative webhooksWebhook の署名シークレットの取得と更新

すべてのコマンドで --json や --workspace などのグローバルオプションを使えます。

モデル

使えるモデルと単価は Workspace によって変わります。生成の前に models list で確認してください。

terminal
orc creative image models list
orc creative video models list
orc creative tts models list

モデルごとの入力パラメータと料金の形状はモデルにまとまっています。

料金

生成したジョブの分だけ料金がかかります。モデルごとの単価の形状はモデルを、失敗や取り消し時の扱いは料金とデータ保持を参照してください。

関連ページ