workspaces
@orchestor-inc/cli のコマンドリファレンスです。
対象地域・言語の管理
ダッシュボードと同じ対象地域・対象言語を、顧客のAPIキーで取得・更新できます。
orc workspaces measurement-targets get --workspace wks_example --json
printf '%s' '{"measurement_country_codes":["JP","US"],"measurement_language_codes":["ja","en"]}' | orc workspaces measurement-targets update --workspace wks_example --stdin --json取得結果には、保存済みの地域・言語、既定値、選択可能なコード一覧、追加枠を含む契約上限が含まれます。配列は全体を置き換えるため、追加するときは既存の値も含めてください。先頭の値が既定になります。契約上限は有効なプロンプトの地域・言語も含めて検証します。この操作で追加枠の購入は行いません。
APIは GET /v1/workspaces/current/measurement-targets と PATCH /v1/workspaces/current/measurement-targets です。Authorization: Bearer <APIキー> と X-Workspace-ID を指定します。取得にはread、変更にはwriteスコープが必要です。
MCPでは workspace_measurement_targets_get と workspace_measurement_targets_update を使います。更新はwriteプロファイルを有効にし、idempotency_key と変更対象の配列を指定してください。初回に返る approval_required の approval_id を、利用者の承認後に approval_receipt として同一入力に添えて再送します。承認前に保存は実行されません。
コマンド一覧
orc workspaces setup get— Get the durable onboarding journey checkpointorc workspaces measurement-configurations get— Get the Workspace measurement configurationorc workspaces measurement-configurations update— Update the Workspace measurement configurationorc workspaces measurement-configurations revisions list— List append-only measurement configuration revisionsorc workspaces list— List workspacesorc workspaces create— Create workspaceorc workspaces quotas get— Get workspace quotasorc workspaces get— Get workspaceorc workspaces update— Update workspaceorc workspaces archive— Archive workspaceorc workspaces restore— Restore workspaceorc workspaces pause— Pause workspace measurementorc workspaces resume— Resume workspace measurementorc workspaces members list— List workspace membersorc workspaces members create— Add workspace memberorc workspaces members delete— Remove workspace member
orc workspaces setup get
Get the durable onboarding journey checkpoint
構文
orc workspaces setup get [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--wait | boolean | いいえ | セットアップと初回観測が終端するまで待機します。 |
--timeout | string | いいえ | 最大待機時間です。例: 30s、5m。 |
--poll-interval | string | いいえ | 状態を再取得する間隔です。既定は 5s です。 |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc workspaces setup get --helporc workspaces measurement-configurations get
Get the Workspace measurement configuration
構文
orc workspaces measurement-configurations get [flags]出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc workspaces measurement-configurations get --helporc workspaces measurement-configurations update
Update the Workspace measurement configuration
構文
orc workspaces measurement-configurations update [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--default-location | string | はい | 既定の地域を表す JSON オブジェクト。 |
--default-language | string | はい | 既定の言語コード。 |
--platform-selection | string | はい | 対象モデルを表す JSON オブジェクト。 |
完全な JSON オブジェクトを --stdin へ渡すと、三つの設定値を一つのリソースとして送信できます。
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc workspaces measurement-configurations update --helporc workspaces measurement-configurations revisions list
List append-only measurement configuration revisions
構文
orc workspaces measurement-configurations revisions list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--limit | number | いいえ | 返す項目の最大数。 |
--cursor | string | いいえ | 次のページを取得するためのカーソル。 |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc workspaces measurement-configurations revisions list --helporc workspaces list
List workspaces
構文
orc workspaces list [flags]フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--include-archived | string | いいえ | Include archived workspaces in the response.; enum: true|false |
--include-management | string | いいえ | Include brand, monitoring configuration, and production prompt entitlement summaries for accessible workspaces.; enum: true|false |
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace list
ヘルプ
orc workspaces list --helporc workspaces create
Create workspace
brand を指定すると、管理対象ブランドは有効な状態で登録されます。別途ブランドを有効化する必要はありません。setup_mode: "empty" は候補生成と計測を行わず、suggestions は候補生成まで、measure は生成と計測まで進めます。手動で作成した下書きプロンプトは、有効化してから計測してください。
構文
orc workspaces 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. |
--name | string | いいえ | (required) Workspace display name.; max 120 chars |
--slug | string | いいえ | URL-safe workspace slug. |
--workspace-type | string | いいえ | Workspace type.; enum: personal|team |
--client-label | string | いいえ | Optional client-facing label for agency-owned client workspaces. |
--purpose | string | いいえ | Commercial workspace purpose. Pitch workspaces require an agency organization and consume the monthly and active pitch quotas.; enum: client|pitch |
--brand | string | いいえ | Body field: brand; (JSON object, e.g. '{"custom_id":"x"}') |
--default-country-code | string | いいえ | ISO 3166-1 alpha-2 default country code. |
--default-language-code | string | いいえ | ISO 639-1 default language code. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace create
ヘルプ
orc workspaces create --helporc workspaces quotas get
Get workspace quotas
構文
orc workspaces quotas get [flags]出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
ヘルプ
orc workspaces quotas get --helporc workspaces get
Get workspace
構文
orc workspaces get <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace ID. |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace get
ヘルプ
orc workspaces get --helporc workspaces update
Update workspace
構文
orc workspaces update <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace ID. |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | 同じ request を安全に再送するための一意な key。保持期間は 24 時間です。 |
--name | string | いいえ | Workspace display name.; max 120 chars |
--slug | string | いいえ | URL-safe workspace slug. |
--client-label | string | いいえ | Optional client-facing label. |
--color-token | string | いいえ | Workspace visual identity color token.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red |
--identity-kind | string | いいえ | Workspace visual identity rendering mode.; enum: color|initial|icon|emoji|image |
--icon-token | string | いいえ | Body field: icon_token; max 64 chars |
--emoji | string | いいえ | Body field: emoji; max 32 chars |
--image-file-id | string | いいえ | File ID for workspace visual identity image. |
--purpose | string | いいえ | archive されていない pitch workspace を client へ変換します。指定値は client です。 |
--dry-run | boolean | いいえ | 変換後の応答を返し、変更を永続化しません。 |
--yes | boolean | いいえ | 対話確認を省略します。 |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace update
ヘルプ
orc workspaces update --helporc workspaces archive
Archive workspace
構文
orc workspaces archive <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace 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 workspace archive
ヘルプ
orc workspaces archive --helporc workspaces restore
Restore workspace
構文
orc workspaces restore <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace 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 workspace restore
ヘルプ
orc workspaces restore --helporc workspaces pause
Pause workspace measurement
構文
orc workspaces pause <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace ID. |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | 同じ request を安全に再送するための一意な key。保持期間は 24 時間です。 |
--dry-run | boolean | いいえ | 休止後の応答を返し、変更を永続化しません。 |
--yes | boolean | いいえ | 対話確認を省略します。 |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace pause
ヘルプ
orc workspaces pause --helporc workspaces resume
Resume workspace measurement
構文
orc workspaces resume <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace ID. |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--idempotency-key | string | いいえ | 同じ request を安全に再送するための一意な key。保持期間は 24 時間です。 |
--dry-run | boolean | いいえ | 再開後の応答を返し、変更を永続化しません。 |
--yes | boolean | いいえ | 対話確認を省略します。 |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace resume
ヘルプ
orc workspaces resume --helporc workspaces members list
List workspace members
構文
orc workspaces members list <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace ID. |
フラグ
| フラグ | 型 | 必須 | 説明 |
|---|---|---|---|
--limit | number | いいえ | Maximum number of items to return |
--cursor | string | いいえ | Opaque cursor for the next page |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace-member list
ヘルプ
orc workspaces members list --helporc workspaces members create
Add workspace member
構文
orc workspaces members create <id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace 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. |
--user-id | string | いいえ | (required) Organization user ID to assign to this workspace. |
--workspace-role | string | いいえ | Workspace role.; enum: owner|member |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace-member add
ヘルプ
orc workspaces members create --helpアクセス権付与の前提
<id> は access を付与する対象 workspace の ID です。--user-id には同じ組織に所属する active な人間の Organization user ID を指定します。組織スコープの write API key または workspace の owner/admin がこの操作を実行できます。API key の apikey:... synthetic ID を人間の user ID として指定しないでください。
組織キーで作成した workspace には人間の workspace_members が自動作成されないため、作成後にこの操作を実行します。組織キーの組織境界と対象 workspace の所属組織が一致しない場合は 404 になり、read-only key や権限のない人間は 403 になります。付与後は人間 operator の profile で orc workspace use <id> または各データコマンドの --workspace <id> を使います。
workspaces quotas get は組織の利用枠を読む control-plane 操作です。workspace-scoped key での quota 読み取りは 403 insufficient_scope になり、空の quota と解釈しません。quota、workspace 作成、member grant は組織キーに戻し、setup・brands・prompts・reports は grant 済みの人間または workspace-scoped credential で読みます。
orc workspaces members delete
Remove workspace member
構文
orc workspaces members delete <id> <user-id> [flags]引数
| 引数 | 必須 | 説明 |
|---|---|---|
id | はい | Workspace ID. |
user-id | はい | Path parameter: user_id |
出力とリクエストの共通オプションはグローバルオプションを参照してください。このコマンドで使えるフラグは --help で確認できます。
互換エイリアス
orc workspace-member remove
ヘルプ
orc workspaces members delete --help