workspaces
This page is the command reference for @orchestor-inc/cli.
Commands
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 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
Usage
orc workspaces setup get [flags]See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc workspaces setup get --helporc workspaces measurement-configurations get
Get the Workspace measurement configuration
Usage
orc workspaces measurement-configurations get [flags]See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc workspaces measurement-configurations get --helporc workspaces measurement-configurations update
Update the Workspace measurement configuration
Usage
orc workspaces measurement-configurations update [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--default-location | string | Yes | The default location as a JSON object. |
--default-language | string | Yes | The default language code. |
--platform-selection | string | Yes | The selected models as a JSON object. |
Pass a complete JSON object to --stdin to send the three settings as one resource.
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc workspaces measurement-configurations update --helporc workspaces measurement-configurations revisions list
List append-only measurement configuration revisions
Usage
orc workspaces measurement-configurations revisions list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--limit | number | No | Maximum number of items to return. |
--cursor | string | No | 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 workspaces measurement-configurations revisions list --helporc workspaces list
List workspaces
Usage
orc workspaces list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--include-archived | string | No | Include archived workspaces in the response.; enum: true|false |
--include-management | string | No | Include brand, monitoring configuration, and production prompt entitlement summaries for accessible workspaces.; enum: true|false |
--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 workspace list
Help
orc workspaces list --helporc workspaces create
Create workspace
A supplied brand is registered as an active owned brand; no separate brand activation is required. setup_mode: "empty" skips generation and measurement, suggestions stops at generated candidates, and measure generates and measures. Manually created draft prompts must be activated before measurement.
Usage
orc workspaces 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. |
--name | string | No | (required) Workspace display name.; max 120 chars |
--slug | string | No | URL-safe workspace slug. |
--workspace-type | string | No | Workspace type.; enum: personal|team |
--client-label | string | No | Optional client-facing label for agency-owned client workspaces. |
--purpose | string | No | Commercial workspace purpose. Pitch workspaces require an agency organization and consume the monthly and active pitch quotas.; enum: client|pitch |
--brand | string | No | Body field: brand; (JSON object, e.g. '{"custom_id":"x"}') |
--default-country-code | string | No | ISO 3166-1 alpha-2 default country code. |
--default-language-code | string | No | ISO 639-1 default language code. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc workspace create
Help
orc workspaces create --helporc workspaces quotas get
Get workspace quotas
Usage
orc workspaces quotas get [flags]See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc workspaces quotas get --helporc workspaces get
Get workspace
Usage
orc workspaces get <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Workspace ID. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc workspace get
Help
orc workspaces get --helporc workspaces update
Update workspace
Usage
orc workspaces update <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Workspace ID. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | No | Workspace display name.; max 120 chars |
--slug | string | No | URL-safe workspace slug. |
--client-label | string | No | Optional client-facing label. |
--color-token | string | No | Workspace visual identity color token.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red |
--identity-kind | string | No | Workspace visual identity rendering mode.; enum: color|initial|icon|emoji|image |
--icon-token | string | No | Body field: icon_token; max 64 chars |
--emoji | string | No | Body field: emoji; max 32 chars |
--image-file-id | string | No | File ID for workspace visual identity image. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc workspace update
Help
orc workspaces update --helporc workspaces archive
Archive workspace
Usage
orc workspaces archive <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Workspace 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.
Compatibility aliases
orc workspace archive
Help
orc workspaces archive --helporc workspaces restore
Restore workspace
Usage
orc workspaces restore <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Workspace 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.
Compatibility aliases
orc workspace restore
Help
orc workspaces restore --helporc workspaces members list
List workspace members
Usage
orc workspaces members list <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Workspace ID. |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--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 workspace-member list
Help
orc workspaces members list --helporc workspaces members create
Add workspace member
Usage
orc workspaces members create <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Workspace 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. |
--user-id | string | No | (required) Organization user ID to assign to this workspace. |
--workspace-role | string | No | Workspace role.; enum: owner|member |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc workspace-member add
Help
orc workspaces members create --helpAccess grant prerequisites
<id> is the target workspace that receives the assignment. Set --user-id to the user ID of an active human organization member in the same organization. An organization-scoped write API key or a workspace owner/admin can perform this operation. Never pass an API key's apikey:... synthetic ID as a human user ID.
A workspace created with an organization key does not automatically create a human workspace_members row, so run this operation after creation. A target workspace outside the key's organization returns 404; a read-only key or a human without the required permission returns 403. After the grant, use orc workspace use <id> in the human operator profile or pass --workspace <id> to each data command.
workspaces quotas get reads organization capacity and is a control-plane operation. A workspace-scoped key receives 403 insufficient_scope for quota reads; do not interpret that as an empty quota. Keep quota, workspace creation, and member grants on the organization key, and read setup, brands, prompts, and reports with the granted human or a workspace-scoped credential.
orc workspaces members delete
Remove workspace member
Usage
orc workspaces members delete <id> <user-id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Workspace ID. |
user-id | Yes | Path parameter: user_id |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc workspace-member remove
Help
orc workspaces members delete --help