CLI

creative jobs

orc creative jobs は、image generate、video generate、tts generate、voice change が作成したジョブを扱います。jobs status で状態を、jobs result で成果物を取得し、jobs events で状態の履歴を確認します。

ジョブは COMPLETED、FAILED、CANCELED のいずれかで終わります。取り消せるのはキュー待ちのジョブだけです。状態確認の間隔はポーリングを参照してください。

使い方

terminal
orc creative jobs status <id> --json

ジョブの状態を確認します。

terminal
orc creative jobs result <id> --json

完了したジョブの成果物を取得します。

サブコマンド

list

ジョブを一覧表示

terminal
orc creative jobs list [options]

固有のオプション

--type

取得する生成ジョブの種類。省略するとすべての種類を取得します。

型: string。任意。

terminal
orc creative jobs list --type <value>
--types

複数の種類をまとめて取得する場合に、types=image-router&types=video-router のように繰り返して指定します。type と同時には指定できません。; csv

型: string。任意。

terminal
orc creative jobs list --types <value>
--status

取得するジョブの処理状態。; enum: queued|processing|completed|failed|canceled

型: string。任意。

terminal
orc creative jobs list --status <value>
--starting-after

前のページの next_cursor。省略すると新しいジョブから取得します。

型: string。任意。

terminal
orc creative jobs list --starting-after <value>

get

ジョブを取得

terminal
orc creative jobs get <id> [options]

status

ジョブの状態を取得

terminal
orc creative jobs status <id> [options]

result

ジョブの結果を取得

terminal
orc creative jobs result <id> [options]

events

ジョブのイベントを一覧表示

terminal
orc creative jobs events <id> [options]

cancel

ジョブをキャンセル

terminal
orc creative jobs cancel <id> [options]

使用例

Workspace の失敗したジョブを一覧します。

terminal
orc creative jobs list --status failed --json

Workspace の失敗したジョブを一覧します。

状態の履歴を確認します。

terminal
orc creative jobs events <id> --json

状態の履歴を確認します。

キュー待ちのジョブを取り消します。

terminal
orc creative jobs cancel <id>

キュー待ちのジョブを取り消します。

必要な権限

CLI の認証(orc auth login または ORCHESTOR_API_KEY)と、対象 Workspace へのアクセスが必要です。 ジョブの取り消しには書き込み権限が必要です。

グローバルオプション

orc creative jobs では、次のグローバルオプションを使用できます。

各オプションの詳細と使用例は、グローバルオプションを参照してください。