Getting started

prompts

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

Commands

orc prompts list — List AI Search prompts
orc prompts create — Create AI Search prompt
orc prompts get — Get AI Search prompt
orc prompts update — Update AI Search prompt
orc prompts delete — Remove an AI Search prompt from active views
orc prompts disable — Disable AI Search prompt
orc prompts enable — Enable AI Search prompt
orc prompts suggestions list — List prompt suggestions
orc prompts suggestions refresh — Generate prompt suggestions
orc prompts suggestions generations get — Get prompt suggestion generation
orc prompts suggestions accept — Accept suggestion (promote to prompt)
orc prompts suggestions reject — Reject suggestion
orc prompts tags get — List tags on a prompt
orc prompts tags update — Replace prompt tags (bulk)

orc prompts list

List AI Search prompts

Usage

orc prompts list [flags]

Flags

Flag	Type	Required	Description
`--topic-id`	`string`	No	Filter prompts attached to one Topic.
`--status`	`string`	No	Filter prompts by lifecycle status.; enum: active\|disabled\|archived
`--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 prompt list

Help

orc prompts list --help

orc prompts create

Create AI Search prompt

Usage

orc prompts 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.
`--topic-id`	`string`	No	Optional Topic reference used to attach this prompt to an observation topic.; (use "null" or "reset" to clear)
`--text`	`string`	No	(required) The prompt text to send to LLM platforms.; max 2000 chars
`--persona-ids`	`string`	No	Existing workspace Persona IDs to associate with the Prompt.; csv
`--platforms`	`string`	No	Stable measurement channel IDs to monitor. Discover available values with `orc channels list`.; csv
`--region-id`	`string`	No	Observation/measurement region identifier used when executing this prompt. If omitted, supported `country_code` values resolve to a default locale. This is not Organization residency.
`--language-code`	`string`	No	BCP 47 language code used when executing this prompt. If omitted, supported `country_code` values resolve to a default language.
`--country-code`	`string`	No	ISO 3166 observation country used when executing this prompt. Common forms such as `JP`, `jp`, `JPN`, and locale-style `ja-JP` are normalized to the canonical alpha-2 country code when supported. This does not control Organization residency.; (use "null" or "reset" to clear)
`--status`	`string`	No	Lifecycle status. Defaults to `active`; `disabled` preserves history and stops future execution.; enum: active\|disabled
`--schedule`	`string`	No	Cron expression for periodic collection.; max 100 chars
`--branding`	`string`	No	Mutually exclusive branding classification automatically maintained for every prompt.; enum: non_branded\|branded
`--intent-type`	`string`	No	Mutually exclusive search-intent classification automatically maintained for every prompt.; enum: informational\|commercial\|transactional
`--preview`	`string`	No	When `true`, validate and resolve the Prompt without persistence. Requires `Idempotency-Key`; read-scope API keys may use only this mode.

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

Compatibility aliases

orc prompt create

Help

orc prompts create --help

orc prompts get

Get AI Search prompt

Usage

orc prompts 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 prompt get

Help

orc prompts get --help

orc prompts update

Update AI Search prompt

Usage

orc prompts update <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.
`--text`	`string`	No	Body field: text; max 2000 chars
`--topic-id`	`string`	No	Existing workspace Topic to associate with the prompt. Set to null to remove the association.; (use "null" or "reset" to clear)
`--persona-ids`	`string`	No	Complete replacement set of existing workspace Persona IDs associated with the Prompt.; csv
`--platforms`	`string`	No	Stable measurement channel IDs to set on the existing prompt.; csv
`--region-id`	`string`	No	Catalog or locale-style region identifier for prompt execution.
`--language-code`	`string`	No	BCP 47 language code for prompt execution.
`--country-code`	`string`	No	ISO 3166 country code for prompt execution. Common forms such as `JP`, `jp`, `JPN`, and locale-style `ja-JP` are normalized to the canonical alpha-2 country code when supported.; (use "null" or "reset" to clear)
`--status`	`string`	No	Lifecycle transition. `disabled` preserves history and stops future execution; `archived` removes the prompt from active work while preserving its history.; enum: active\|disabled\|archived
`--schedule`	`string`	No	Body field: schedule; max 100 chars
`--branding`	`string`	No	Mutually exclusive branding classification automatically maintained for every prompt.; enum: non_branded\|branded
`--intent-type`	`string`	No	Mutually exclusive search-intent classification automatically maintained for every prompt.; enum: informational\|commercial\|transactional
`--config-revision`	`number`	No	Optimistic concurrency token. Omission is accepted only during the migration window.
`--preview`	`string`	No	When `true`, validate and resolve the update without persistence. Requires `Idempotency-Key`; read-scope API keys may use only this mode.

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

Compatibility aliases

orc prompt update

Help

orc prompts update --help

orc prompts delete

Remove an AI Search prompt from active views

Usage

orc prompts 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.

Compatibility aliases

orc prompt delete

Help

orc prompts delete --help

orc prompts disable

Disable AI Search prompt

Usage

orc prompts disable <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 prompts disable --help

orc prompts enable

Enable AI Search prompt

Usage

orc prompts enable <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 prompts enable --help

orc prompts suggestions list

List prompt suggestions

Usage

orc prompts suggestions list [flags]

Flags

Flag	Type	Required	Description
`--status`	`string`	No	enum: pending\|accepted\|rejected
`--topic-id`	`string`	No	value
`--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 prompt suggestion-list

Help

orc prompts suggestions list --help

orc prompts suggestions refresh

Generate prompt suggestions

Usage

orc prompts suggestions refresh [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.
`--topic-ids`	`string`	No	(required) Existing workspace topic IDs used as the generation scope.; csv
`--persona-ids`	`string`	No	Existing workspace Persona IDs to distribute across generated suggestions. Omit or send an empty array to generate without Persona context.; csv
`--prompts-per-topic`	`number`	No	Body field: prompts_per_topic
`--language-code`	`string`	No	Body field: language_code
`--country-code`	`string`	No	Body field: country_code
`--instructions`	`string`	No	Optional generation guidance applied to every selected topic.; max 2000 chars
`--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 prompts suggestions refresh --help

orc prompts suggestions generations get

Get prompt suggestion generation

Usage

orc prompts suggestions generations 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.

Help

orc prompts suggestions generations get --help

orc prompts suggestions accept

Accept suggestion (promote to prompt)

Usage

orc prompts suggestions accept <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.
`--topic-id`	`string`	No	Body field: topic_id
`--edit-text`	`string`	No	Body field: edit_text; max 2000 chars

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

Help

orc prompts suggestions accept --help

orc prompts suggestions reject

Reject suggestion

Usage

orc prompts suggestions reject <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 prompts suggestions reject --help

orc prompts tags get

List tags on a prompt

Usage

orc prompts tags 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 prompt tags-get

Help

orc prompts tags get --help

orc prompts tags update

Replace prompt tags (bulk)

Usage

orc prompts tags update <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.
`--tag-ids`	`string`	No	(required) Body field: tag_ids; csv
`--config-revision`	`number`	No	Optimistic concurrency token. Omission is accepted only during the migration window.

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

Compatibility aliases

orc prompt tags-set

Help

orc prompts tags update --help

​prompts

​Commands

​orc prompts list

​Usage

​Flags

​Compatibility aliases

​Help

​orc prompts create

​Usage

​Flags

​Compatibility aliases

​Help

​orc prompts get

​Usage

​Arguments

​Compatibility aliases

​Help

​orc prompts update

​Usage

​Arguments

​Flags

​Compatibility aliases

​Help

​orc prompts delete

​Usage

​Arguments

​Compatibility aliases

​Help

​orc prompts disable

​Usage

​Arguments

​Flags

​Help

​orc prompts enable

​Usage

​Arguments

​Flags

​Help

​orc prompts suggestions list

​Usage

​Flags

​Compatibility aliases

​Help

​orc prompts suggestions refresh

​Usage

​Flags

​Help

​orc prompts suggestions generations get

​Usage

​Arguments

​Help

​orc prompts suggestions accept

​Usage

​Arguments

​Flags

​Help

​orc prompts suggestions reject

​Usage

​Arguments

​Flags

​Help

​orc prompts tags get

​Usage

​Arguments

​Compatibility aliases

​Help

​orc prompts tags update

​Usage

​Arguments

​Flags

​Compatibility aliases

​Help

prompts

Commands

orc prompts list

Usage

Flags

Compatibility aliases

Help

orc prompts create

Usage

Flags

Compatibility aliases

Help

orc prompts get

Usage

Arguments

Compatibility aliases

Help

orc prompts update

Usage

Arguments

Flags

Compatibility aliases

Help

orc prompts delete

Usage

Arguments

Compatibility aliases

Help

orc prompts disable

Usage

Arguments

Flags

Help

orc prompts enable

Usage

Arguments

Flags

Help

orc prompts suggestions list

Usage

Flags

Compatibility aliases

Help

orc prompts suggestions refresh

Usage

Flags

Help

orc prompts suggestions generations get

Usage

Arguments

Help

orc prompts suggestions accept

Usage

Arguments

Flags

Help

orc prompts suggestions reject

Usage

Arguments

Flags

Help

orc prompts tags get

Usage

Arguments

Compatibility aliases

Help

orc prompts tags update

Usage

Arguments

Flags

Compatibility aliases

Help