CLI を使い始める

runs

@orchestor-inc/cli のコマンドリファレンスです。

コマンド一覧

orc runs list — List Prompt Runs
orc runs create — Create a Prompt Run
orc runs get — Get a Prompt Run
orc runs cancel — Cancel a Prompt Run
orc runs results get — Get Prompt Run results
orc runs batches list — List prompt run batches
orc runs batches create — Create a prompt run batch (ASYNC)
orc runs batches get — Retrieve a prompt run batch (status polling)
orc runs batches delete — Delete a prompt run batch
orc runs batches cancel — Cancel a prompt run batch
orc runs batches results get — Get results of a completed prompt run batch

orc runs list

List Prompt Runs

構文

orc runs list [flags]

フラグ

フラグ	型	必須	説明
`--status`	`string`	いいえ	enum: queued\|running\|succeeded\|failed\|canceled
`--limit`	`number`	いいえ	Maximum number of items to return
`--cursor`	`string`	いいえ	Opaque cursor for the next page

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc runs list --help

orc runs create

Create a Prompt Run

構文

orc runs create [flags]

フラグ

フラグ	型	必須	説明
`--idempotency-key`	`string`	いいえ	Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns `409 idempotency_error`. Use a UUID v4 or similar unique identifier.
`--prompt-id`	`string`	いいえ	(required) ID of the tracked prompt to execute.
`--model-channel-id`	`string`	いいえ	この実行で選択する安定した計測チャンネル ID。チャンネル一覧の値を指定します。; max 128 chars
`--persona`	`string`	いいえ	Free-form persona.; (use "null" or "reset" to clear)
`--persona-id`	`string`	いいえ	Catalog persona reference (alternative to free-form `persona`).; (use "null" or "reset" to clear)
`--region`	`string`	いいえ	Free-form region.; (use "null" or "reset" to clear)
`--region-id`	`string`	いいえ	Catalog region reference.; (use "null" or "reset" to clear)
`--topic-id`	`string`	いいえ	Explicit topic context (overrides prompt.topic_id).; (use "null" or "reset" to clear)
`--brand-id`	`string`	いいえ	Focus brand for visibility / mention extraction.; (use "null" or "reset" to clear)
`--asset-id`	`string`	いいえ	Asset identifier (forward compatibility).; (use "null" or "reset" to clear)
`--tag-ids`	`string`	いいえ	Tag context for this execution.; csv; (use "null" or "reset" to clear)
`--prompt-type`	`string`	いいえ	Prompt type.; (use "null" or "reset" to clear)
`--language-code`	`string`	いいえ	BCP 47 language tag (e.g. en-US). Google AI Mode passes this through to SerpApi `hl` and supports Japanese (`ja`), English (`en`), and other SerpApi-supported languages; no unsupported-locale gate is applied by Orchestor.; (use "null" or "reset" to clear)
`--country-code`	`string`	いいえ	ISO 3166-1 alpha-2 country (e.g. US).; (use "null" or "reset" to clear)
`--metadata`	`string`	いいえ	Anthropic / OpenAI metadata bag for client-side correlation.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)
`--include-transcript`	`string`	いいえ	(Q2.EV 2026-05-02) Opt-in raw conversation transcript storage. When `true`, populated `messages: [{role, content}]` field in the returned `PromptAnswerData`. Default `false` for storage cost and privacy/compliance.
`--tools`	`string`	いいえ	Optional model tool controls. MVP accepts boolean `web_search` only.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)
`--wait`	`boolean`	いいえ	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	いいえ	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	いいえ	Delay between status requests (default: 5s) 既定値: 5s

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

orc prompt-run create

ヘルプ

orc runs create --help

orc runs get

Get a Prompt Run

構文

orc runs get <id> [flags]

引数

引数	必須	説明
`id`	はい	Prompt Run id.

フラグ

フラグ	型	必須	説明
`--wait`	`boolean`	いいえ	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	いいえ	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	いいえ	Delay between status requests (default: 5s) 既定値: 5s

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

orc prompt-run get

ヘルプ

orc runs get --help

orc runs cancel

Cancel a Prompt Run

構文

orc runs cancel <id> [flags]

引数

引数	必須	説明
`id`	はい	Path parameter: id

フラグ

フラグ	型	必須	説明
`--idempotency-key`	`string`	いいえ	Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns `409 idempotency_error`. Use a UUID v4 or similar unique identifier.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc runs cancel --help

orc runs results get

Get Prompt Run results

構文

orc runs results get <id> [flags]

引数

引数	必須	説明
`id`	はい	Path parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

orc runs results

ヘルプ

orc runs results get --help

orc runs batches list

List prompt run batches

構文

orc runs batches list [flags]

フラグ

フラグ	型	必須	説明
`--status`	`string`	いいえ	Filter by batch processing status.; enum: running\|canceling\|completed
`--limit`	`number`	いいえ	Maximum number of items to return
`--cursor`	`string`	いいえ	Opaque cursor for the next page

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc runs batches list --help

orc runs batches create

Create a prompt run batch (ASYNC)

構文

orc runs batches create [flags]

フラグ

フラグ	型	必須	説明
`--idempotency-key`	`string`	いいえ	Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns `409 idempotency_error`. Use a UUID v4 or similar unique identifier.
`--requests`	`string`	いいえ	(required) Array of execution requests. Anthropic parity: max 10000 per batch. Each request requires a client-supplied `custom_id` for correlation in the results stream.; JSON array of objects (use --stdin for large resources)
`--metadata`	`string`	いいえ	Batch-level metadata bag.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)
`--completion-window`	`string`	いいえ	OpenAI batch parity. Maximum wall-clock time before the batch expires. Requests still in `processing` at expiration move to `request_counts.expired`.; enum: 24h\|48h
`--wait`	`boolean`	いいえ	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	いいえ	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	いいえ	Delay between status requests (default: 5s) 既定値: 5s

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc runs batches create --help

orc runs batches get

Retrieve a prompt run batch (status polling)

構文

orc runs batches get <id> [flags]

引数

引数	必須	説明
`id`	はい	Prompt Run Batch id (e.g. prb_01abc).

フラグ

フラグ	型	必須	説明
`--wait`	`boolean`	いいえ	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	いいえ	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	いいえ	Delay between status requests (default: 5s) 既定値: 5s

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc runs batches get --help

orc runs batches delete

Delete a prompt run batch

構文

orc runs batches delete <id> [flags]

引数

引数	必須	説明
`id`	はい	Path parameter: id

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc runs batches delete --help

orc runs batches cancel

Cancel a prompt run batch

構文

orc runs batches cancel <id> [flags]

引数

引数	必須	説明
`id`	はい	Path parameter: id

フラグ

フラグ	型	必須	説明
`--idempotency-key`	`string`	いいえ	Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns `409 idempotency_error`. Use a UUID v4 or similar unique identifier.

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

ヘルプ

orc runs batches cancel --help

orc runs batches results get

Get results of a completed prompt run batch

構文

orc runs batches results get <id> [flags]

引数

引数	必須	説明
`id`	はい	Path parameter: id

フラグ

フラグ	型	必須	説明
`--idempotency-key`	`string`	いいえ	Unique key for idempotent POST requests (24h TTL). If a request with the same key was already processed, the original response is returned without re-executing the operation. Reusing a key with a different request payload returns `409 idempotency_error`. Use a UUID v4 or similar unique identifier.
`--limit`	`number`	いいえ	Maximum number of items to return
`--cursor`	`string`	いいえ	Opaque cursor for the next page

出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。

互換エイリアス

orc runs batches results

ヘルプ

orc runs batches results get --help

​runs

​コマンド一覧

​orc runs list

​構文

​フラグ

​ヘルプ

​orc runs create

​構文

​フラグ

​互換エイリアス

​ヘルプ

​orc runs get

​構文

​引数

​フラグ

​互換エイリアス

​ヘルプ

​orc runs cancel

​構文

​引数

​フラグ

​ヘルプ

​orc runs results get

​構文

​引数

​互換エイリアス

​ヘルプ

​orc runs batches list

​構文

​フラグ

​ヘルプ

​orc runs batches create

​構文

​フラグ

​ヘルプ

​orc runs batches get

​構文

​引数

​フラグ

​ヘルプ

​orc runs batches delete

​構文

​引数

​ヘルプ

​orc runs batches cancel

​構文

​引数

​フラグ

​ヘルプ

​orc runs batches results get

​構文

​引数

​フラグ

​互換エイリアス

​ヘルプ

runs

コマンド一覧

orc runs list

構文

フラグ

ヘルプ

orc runs create

構文

フラグ

互換エイリアス

ヘルプ

orc runs get

構文

引数

フラグ

互換エイリアス

ヘルプ

orc runs cancel

構文

引数

フラグ

ヘルプ

orc runs results get

構文

引数

互換エイリアス

ヘルプ

orc runs batches list

構文

フラグ

ヘルプ

orc runs batches create

構文

フラグ

ヘルプ

orc runs batches get

構文

引数

フラグ

ヘルプ

orc runs batches delete

構文

引数

ヘルプ

orc runs batches cancel

構文

引数

フラグ

ヘルプ

orc runs batches results get

構文

引数

フラグ

互換エイリアス

ヘルプ