​

prompts

orc prompts は、Workspaceで計測する質問を管理します。質問文、トピック、ペルソナ、計測チャンネル、地域・言語を作成・更新し、実行を有効化・無効化できます。候補生成と採用、タグの参照・置き換えも扱います。新しい質問は既定で draft となり、計測やactive prompt枠を消費しません。

認証とWorkspaceへのアクセスが必要です。作成・一覧で返されたprompt IDを使います。利用するチャンネルIDは orc channels list、地域codeは orc regions list で確認してください。有効化には残りのprompt枠が必要です。質問を作る操作と、結果を取得する orc runs の操作は別です。

質問のID・状態・保存済み結果の集計を確認します。

platforms はconsumer AI観測チャンネルIDです。既定は chatgpt-ui で、認識された観測aliasは正規化されます。direct provider APIチャンネルは指定できません。ペルソナは同じWorkspaceの既存IDを最大20件指定します。

country_code は対応する JP・jp・JPN・ja-JP などをalpha-2へ正規化し、省略された地域と言語の既定値を補います。明示した値は保持します。これらは計測条件で、組織のデータ保存場所ではありません。language_code はBCP 47です。

schedule は最大100文字の保存cron式です。省略した作成はnullになります。実行は質問のlifecycleとWorkspaceの計測設定にも依存するため、cron保存だけで実行を保証しません。

branding は non_branded または branded、intent_type は informational・commercial・transactional です。前者を省略するとブランド名・別名・domainから分類し、後者の既定値はinformationalです。回答のsentimentではなく質問の分類です。更新時に省略した分類は保持します。

--topic-id と --status で絞り込みます。状態を省略すると全lifecycle状態が対象で、論理削除済みや削除された親配下の質問は除外します。保存済み回答の集計も返しますが、計測は開始しません。

Existing accessible Topic ID. Omit to include prompts across topics and prompts without a topic. A missing or inaccessible Topic returns 404.

型: string。任意。

Return only this lifecycle state. Omit to include draft, active, disabled and archived prompts; deleted prompts remain excluded.; enum: draft|active|disabled|archived

型: string。任意。

Comma-separated platform or channel IDs restricting answer metrics and mentioned brands. Prompt membership is unchanged. Omit for all platforms.; max 2000 chars

型: string。任意。

text は必須で最大2,000文字です。対応する country_code、または region_id と language_code の両方を指定します。topicを持たないactive質問はWorkspaceの既定topicへ割り当てるため、有効な自社ブランドが必要です。同じ文と国の重複は409になります。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

Existing Topic ID in this workspace. Omit or set null to leave a draft or disabled prompt unassigned. Persisted active creation resolves the workspace default topic; preview does not.; (use "null" or "reset" to clear)

型: string。任意。

(required) The prompt text to send to LLM platforms.; max 2000 chars

型: string。任意。

Existing Persona IDs in this workspace. Omit or use an empty array for no persona associations. Missing or inaccessible IDs return 404.; csv

型: string。任意。

Consumer AI observation channel IDs. Defaults to chatgpt-ui. Recognized observation aliases are normalized; direct provider API channels are rejected.; csv of: chatgpt-ui|gemini-ui|perplexity-ui|copilot-ui|google-ai-overview|google-ai-mode

型: string。任意。

Execution region. Required unless the supplied country or another recognized locale field resolves a supported default. Explicit values are preserved. This does not control data residency.

型: string。任意。

Execution language. Required unless the supplied country or another recognized locale field resolves a supported default. Explicit values are preserved.

型: string。任意。

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)

型: string。任意。

Lifecycle status. draft is editable and excluded from measurement and active prompt quota until explicitly activated. Defaults to draft; disabled preserves history and stops future execution.; enum: draft|active|disabled

型: string。任意。

Stored cron expression for periodic collection. Omit to store null. Actual execution also depends on prompt lifecycle and workspace measurement configuration.; max 100 chars

型: string。任意。

Whether the prompt text names a brand (branded) or is generic (non_branded). On creation, omission classifies against registered workspace brand names, aliases and domains. An explicit value takes precedence; measurement does not overwrite manual classifications.; enum: non_branded|branded

型: string。任意。

Search-intent classification of the prompt question. Defaults to informational on creation; omission in a partial update preserves the stored value.; enum: informational|commercial|transactional

型: string。任意。

When true, validate and resolve the Prompt without persistence. Requires Idempotency-Key; read-scope API keys may use only this mode.

型: string。任意。

draftの質問を作成する

質問とペルソナ関連付けを取得します。更新にはこの応答の config_revision を使用します。回答の集計は単件取得では計算されず、list で確認します。

指定項目だけを変更します。ただし指定localeが省略locale項目を補う場合があります。activeな質問の文を変更する前に無効化してください。最新の config_revision を指定し、競合の409時は再取得して変更を見直します。persona_ids と platforms は全体の置き換えです。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

Replacement question text. Omit to retain it. An active prompt must be disabled before its text changes.; max 2000 chars

型: string。任意。

Replacement accessible Topic ID. Omit to retain the association. Null clears a non-active association; an active prompt resolves a default topic and requires an active owned brand.; (use "null" or "reset" to clear)

型: string。任意。

Complete replacement of persona associations. Omit to retain them; use [] to clear them. Every ID must belong to this workspace.; csv

型: string。任意。

Complete replacement of observation channels. Omit to retain the selection. Recognized observation aliases are normalized; direct provider API channels are rejected.; csv of: chatgpt-ui|gemini-ui|perplexity-ui|copilot-ui|google-ai-overview|google-ai-mode

型: string。任意。

Replacement execution region. Omit to retain it unless another supplied locale field derives a supported default.

型: string。任意。

Replacement execution language. Omit to retain it unless another supplied locale field derives a supported default.

型: string。任意。

Replacement observation country. Supported country and locale forms are normalized and can populate omitted region_id and language_code. Omit all locale fields to retain the current locale.; (use "null" or "reset" to clear)

型: string。任意。

Lifecycle transition. disabled preserves history and stops future execution; archived removes the prompt from active work while preserving its history.; enum: draft|active|disabled|archived

型: string。任意。

Replacement stored cron expression. Omit to retain it. This request schema does not accept null.; max 100 chars

型: string。任意。

Whether the prompt text names a brand (branded) or is generic (non_branded). On creation, omission classifies against registered workspace brand names, aliases and domains. An explicit value takes precedence; measurement does not overwrite manual classifications.; enum: non_branded|branded

型: string。任意。

Search-intent classification of the prompt question. Defaults to informational on creation; omission in a partial update preserves the stored value.; enum: informational|commercial|transactional

型: string。任意。

Latest revision from a prompt response. A mismatch returns 409 when applying a change. Omission remains accepted during the migration window; do not use a preview revision as a saved revision.

型: number。任意。

When true, validate and resolve the update without persistence. Requires Idempotency-Key; read-scope API keys may use only this mode.

型: string。任意。

無効化した質問の文を変更する

質問を論理削除して通常の一覧・取得から外します。質問と観測履歴は30日の保持期間後に日次purgeで完全削除されます。将来の観測だけを止める場合は disable を使用してください。削除済みへの再送は404です。

draft・active・archivedの質問をdisabledにして、設定と履歴を保ったまま将来の観測を止めます。すでにdisabledなら409です。応答は更新後の config_revision を含みます。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

draft・disabled・archivedの質問をactiveにします。active枠不足は402、すでにactiveなら409です。topic未指定時の既定割り当てには有効な自社ブランドが必要です。停止期間を埋め戻さず、完了した計測結果を返す操作でもありません。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

保存された候補を status と topic_id で絞って取得します。省略したstatusはpending・accepted・rejectedを含みます。この読み取りは生成を開始しません。

Review state to include. Omit for all states.; enum: pending|accepted|rejected

型: string。任意。

Limit results to this parent topic. Omit to include all topics in the workspace.

型: string。任意。

既存Workspaceのtopic ID群で非同期生成を開始します。--topic-ids は必須です。persona_ids を省略または空にするとペルソナなしで生成します。instructions は最大2,000文字で、選んだ全topicへ適用します。受付応答がdispatch失敗を含む場合もあります。生成は質問を有効化しません。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

(required) Existing topic IDs in this workspace. Select 1–20 entries; repeated IDs are deduplicated before generation. Missing or deleted topics are rejected.; csv

型: string。任意。

Existing workspace Persona IDs to distribute across generated suggestions. Omit or send an empty array to generate without Persona context.; csv

型: string。任意。

Requested new candidates per distinct topic, from 1 to 20. Defaults to 5. Deduplication or generation results can produce fewer stored candidates.

型: number。任意。

Language context for generated prompt text. Defaults to ja-JP.

型: string。任意。

Country context for generation. Defaults to JP.

型: string。任意。

Optional generation guidance applied to every selected topic.; max 2000 chars

型: string。任意。

topicから候補を生成して待つ

返された生成IDで状態と結果を取得します。--wait を使わなかった生成も、この操作と候補一覧で確認できます。

pending候補をdisabledの新規質問へ昇格し、同じtransactionでacceptedにします。計測は自動開始しません。必要なら --edit-text と --topic-id を指定します。候補にtopicがない場合はtopicの指定が必要です。解決済み候補は409です。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

Destination topic in the same workspace. Omit to use the suggestion topic. Required when the suggestion has no topic.

型: string。任意。

Replacement prompt text, up to 2000 characters. Omit to preserve the suggestion text. Providing an edit also causes branding to be resolved for the edited text.; max 2000 chars

型: string。任意。

pending候補をrejectedにして解決時刻を記録します。質問は作成せず、候補はrejected一覧へ残ります。解決済みは409、不明IDは404です。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

質問に関連する有効なタグを古い作成順で取得します。ページ分割しません。現在のAPIは削除されていないtopicとbrandを介して質問を解決するため、topicなしの質問は404です。

tag_ids に関連付けの完全な一覧を渡して置き換えます。最新の config_revision を指定してください。1つのタグを追加する場合も保持するIDをすべて含めます。

Retry identity for operations that support idempotency. Use a unique key for each new operation, and reuse it only when retrying the same HTTP method, path, query values and exact request body. JSON whitespace changes can count as a different body. Keys contain 1–255 characters after trimming and expire after 24 hours. A completed JSON response is replayed without repeating the operation. A different request using the same key returns 409 idempotency_error. An in-progress request returns 409 idempotency_in_progress with Retry-After: 2. Whether this header is required depends on the operation.

型: string。任意。

(required) Complete replacement tag set. Supply distinct active IDs from this workspace; [] removes all tags. Unknown or repeated IDs are rejected.; csv

型: string。任意。

Current prompt revision for optimistic concurrency. A mismatch returns 409 without changing tags. Omission currently skips the revision check.

型: number。任意。

preview は保存しない投影を返します。--dry-run と違ってAPIへ送信します。quota予約、保存済み重複の拒否、既定topic作成は行いません。

サーバーで保存前の設定を検証する

作成・更新の preview true は Idempotency-Key が必須で、read-scope APIキーでも使用できます。保存する作成にはwrite scope、更新などの設定変更には workspace:settings が必要です。previewのrevisionを保存済みrevisionとして使用しないでください。

config_revision の省略は移行期間のみ許容されます。最新の保存値を使って編集し、競合時は上書きせず再取得して確認します。質問の状態変更は enable と disable を優先してください。削除済みの質問はそれらでは復元されません。

対象Workspaceへのアクセスが必要です。変更操作には対応する書き込み権限が必要です。

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

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