creative jobs
orc creative jobs works with the jobs that image generate, video generate, tts generate and voice change create. jobs status returns the state, jobs result the artifacts, and jobs events the state history.
A job ends as COMPLETED, FAILED or CANCELED. Only queued jobs can be canceled. See Polling for status intervals.
Usage
orc creative jobs status <id> --jsonCheck a job's status.
orc creative jobs result <id> --jsonGet a completed job's artifacts.
Subcommands
list
ジョブを一覧表示
orc creative jobs list [options]Unique options
--type
取得する生成ジョブの種類。省略するとすべての種類を取得します。
Type: string. Optional.
orc creative jobs list --type <value>--types
複数の種類をまとめて取得する場合に、types=image-router&types=video-router のように繰り返して指定します。type と同時には指定できません。; csv
Type: string. Optional.
orc creative jobs list --types <value>--status
取得するジョブの処理状態。; enum: queued|processing|completed|failed|canceled
Type: string. Optional.
orc creative jobs list --status <value>--starting-after
前のページの next_cursor。省略すると新しいジョブから取得します。
Type: string. Optional.
orc creative jobs list --starting-after <value>get
ジョブを取得
orc creative jobs get <id> [options]status
ジョブの状態を取得
orc creative jobs status <id> [options]result
ジョブの結果を取得
orc creative jobs result <id> [options]events
ジョブのイベントを一覧表示
orc creative jobs events <id> [options]cancel
ジョブをキャンセル
orc creative jobs cancel <id> [options]Examples
List the Workspace's failed jobs.
orc creative jobs list --status failed --jsonList the Workspace's failed jobs.
Show the state history.
orc creative jobs events <id> --jsonShow the state history.
Cancel a queued job.
orc creative jobs cancel <id>Cancel a queued job.
Permissions
Requires CLI authentication (orc auth login or ORCHESTOR_API_KEY) and access to the target Workspace. Canceling a job requires write access.
Global Options
The following global options can be used with orc creative jobs:
For details and examples, see global options.