Getting started

runs

This page is the command reference for @orchestor-inc/cli.

Commands

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

Usage

orc runs list [flags]

Flags

Flag	Type	Required	Description
`--status`	`string`	No	enum: queued\|running\|succeeded\|failed\|canceled
`--limit`	`number`	No	Maximum number of items to return
`--cursor`	`string`	No	Opaque cursor for the next page

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc runs list --help

orc runs create

Create a Prompt Run

Usage

orc runs create [flags]

Flags

Flag	Type	Required	Description
`--idempotency-key`	`string`	No	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`	No	(required) ID of the tracked prompt to execute.
`--model-channel-id`	`string`	No	Stable measurement channel ID selected for this run. Use a value from the channel catalog.; max 128 chars
`--persona`	`string`	No	Free-form persona.; (use "null" or "reset" to clear)
`--persona-id`	`string`	No	Catalog persona reference (alternative to free-form `persona`).; (use "null" or "reset" to clear)
`--region`	`string`	No	Free-form region.; (use "null" or "reset" to clear)
`--region-id`	`string`	No	Catalog region reference.; (use "null" or "reset" to clear)
`--topic-id`	`string`	No	Explicit topic context (overrides prompt.topic_id).; (use "null" or "reset" to clear)
`--brand-id`	`string`	No	Focus brand for visibility / mention extraction.; (use "null" or "reset" to clear)
`--asset-id`	`string`	No	Asset identifier (forward compatibility).; (use "null" or "reset" to clear)
`--tag-ids`	`string`	No	Tag context for this execution.; csv; (use "null" or "reset" to clear)
`--prompt-type`	`string`	No	Prompt type.; (use "null" or "reset" to clear)
`--language-code`	`string`	No	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`	No	ISO 3166-1 alpha-2 country (e.g. US).; (use "null" or "reset" to clear)
`--metadata`	`string`	No	Anthropic / OpenAI metadata bag for client-side correlation.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)
`--include-transcript`	`string`	No	(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`	No	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`	No	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	No	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	No	Delay between status requests (default: 5s) Default: 5s

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

orc prompt-run create

Help

orc runs create --help

orc runs get

Get a Prompt Run

Usage

orc runs get <id> [flags]

Arguments

Argument	Required	Description
`id`	Yes	Prompt Run id.

Flags

Flag	Type	Required	Description
`--wait`	`boolean`	No	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	No	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	No	Delay between status requests (default: 5s) Default: 5s

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

orc prompt-run get

Help

orc runs get --help

orc runs cancel

Cancel a Prompt Run

Usage

orc runs cancel <id> [flags]

Arguments

Argument	Required	Description
`id`	Yes	Path parameter: id

Flags

Flag	Type	Required	Description
`--idempotency-key`	`string`	No	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.

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc runs cancel --help

orc runs results get

Get Prompt Run results

Usage

orc runs results get <id> [flags]

Arguments

Argument	Required	Description
`id`	Yes	Path parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

orc runs results

Help

orc runs results get --help

orc runs batches list

List prompt run batches

Usage

orc runs batches list [flags]

Flags

Flag	Type	Required	Description
`--status`	`string`	No	Filter by batch processing status.; enum: running\|canceling\|completed
`--limit`	`number`	No	Maximum number of items to return
`--cursor`	`string`	No	Opaque cursor for the next page

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc runs batches list --help

orc runs batches create

Create a prompt run batch (ASYNC)

Usage

orc runs batches create [flags]

Flags

Flag	Type	Required	Description
`--idempotency-key`	`string`	No	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`	No	(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`	No	Batch-level metadata bag.; (JSON object, e.g. '{"custom_id":"x"}'); (use "null" or "reset" to clear)
`--completion-window`	`string`	No	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`	No	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	No	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	No	Delay between status requests (default: 5s) Default: 5s

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc runs batches create --help

orc runs batches get

Retrieve a prompt run batch (status polling)

Usage

orc runs batches get <id> [flags]

Arguments

Argument	Required	Description
`id`	Yes	Prompt Run Batch id (e.g. prb_01abc).

Flags

Flag	Type	Required	Description
`--wait`	`boolean`	No	Wait for an asynchronous operation to finish and print its result
`--timeout`	`string`	No	Maximum wait duration (for example 30s or 5m)
`--poll-interval`	`string`	No	Delay between status requests (default: 5s) Default: 5s

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc runs batches get --help

orc runs batches delete

Delete a prompt run batch

Usage

orc runs batches delete <id> [flags]

Arguments

Argument	Required	Description
`id`	Yes	Path parameter: id

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc runs batches delete --help

orc runs batches cancel

Cancel a prompt run batch

Usage

orc runs batches cancel <id> [flags]

Arguments

Argument	Required	Description
`id`	Yes	Path parameter: id

Flags

Flag	Type	Required	Description
`--idempotency-key`	`string`	No	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.

See global flags for output and request options. Use --help to check the flags supported by this command.

Help

orc runs batches cancel --help

orc runs batches results get

Get results of a completed prompt run batch

Usage

orc runs batches results get <id> [flags]

Arguments

Argument	Required	Description
`id`	Yes	Path parameter: id

Flags

Flag	Type	Required	Description
`--idempotency-key`	`string`	No	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`	No	Maximum number of items to return
`--cursor`	`string`	No	Opaque cursor for the next page

See global flags for output and request options. Use --help to check the flags supported by this command.

Compatibility aliases

orc runs batches results

Help

orc runs batches results get --help

​runs

​Commands

​orc runs list

​Usage

​Flags

​Help

​orc runs create

​Usage

​Flags

​Compatibility aliases

​Help

​orc runs get

​Usage

​Arguments

​Flags

​Compatibility aliases

​Help

​orc runs cancel

​Usage

​Arguments

​Flags

​Help

​orc runs results get

​Usage

​Arguments

​Compatibility aliases

​Help

​orc runs batches list

​Usage

​Flags

​Help

​orc runs batches create

​Usage

​Flags

​Help

​orc runs batches get

​Usage

​Arguments

​Flags

​Help

​orc runs batches delete

​Usage

​Arguments

​Help

​orc runs batches cancel

​Usage

​Arguments

​Flags

​Help

​orc runs batches results get

​Usage

​Arguments

​Flags

​Compatibility aliases

​Help

runs

Commands

orc runs list

Usage

Flags

Help

orc runs create

Usage

Flags

Compatibility aliases

Help

orc runs get

Usage

Arguments

Flags

Compatibility aliases

Help

orc runs cancel

Usage

Arguments

Flags

Help

orc runs results get

Usage

Arguments

Compatibility aliases

Help

orc runs batches list

Usage

Flags

Help

orc runs batches create

Usage

Flags

Help

orc runs batches get

Usage

Arguments

Flags

Help

orc runs batches delete

Usage

Arguments

Help

orc runs batches cancel

Usage

Arguments

Flags

Help

orc runs batches results get

Usage

Arguments

Flags

Compatibility aliases

Help