Getting started
brands
This page is the command reference for @orchestor-inc/cli.
Commands
orc brands list— List AI Search brandsorc brands create— Create AI Search brandorc brands suggestions list— List brand suggestionsorc brands suggestions refresh— Generate brand suggestionsorc brands suggestions generations get— Get brand suggestion generationorc brands suggestions accept— Accept a brand suggestionorc brands suggestions reject— Reject a brand suggestionorc brands get— Get AI Search brandorc brands update— Update AI Search brandorc brands delete— Soft-delete AI Search brand
orc brands list
List AI Search brands
Usage
orc brands list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--relation | string | No | Filter by relation. When omitted, owned and direct_competitor are returned by default.; enum: owned|direct_competitor|indirect_competitor|ignored |
--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 brand list
Help
orc brands list --helporc brands create
Create AI Search brand
Usage
orc brands 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) Human-readable brand name.; max 255 chars |
--domain | string | No | (required) Primary domain. On create, a Domain entity with role: primary is auto-created and linked via Domain.brand_id.; max 255 chars |
--relation | string | No | Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored |
--tags | string | No | Body field: tags; csv |
--logo-url | string | No | Optional logo URL.; (use "null" or "reset" to clear) |
--display-name | string | No | Optional display name distinct from name.; (use "null" or "reset" to clear) |
--industry | string | No | Optional industry tag.; (use "null" or "reset" to clear) |
--status | string | No | Lifecycle status. Defaults to active; disabled preserves history and stops future execution.; enum: active|disabled |
--domains | string | No | Optional full URL registry; first value becomes domain.; csv |
--aliases | string | No | Alternate brand names used for matching.; csv |
--color-hex | string | No | Optional UI color token in; (use "null" or "reset" to clear) |
--color-token | string | No | Canonical identity color token.; enum: default|gray|brown|orange|yellow|green|blue|purple|pink|red |
--identity-kind | string | No | Active identity presentation mode.; enum: color|initial|icon|emoji|image |
--icon-token | string | No | Icon token reference when identity_kind=icon.; (use "null" or "reset" to clear) |
--emoji | string | No | Emoji glyph when identity_kind=emoji.; (use "null" or "reset" to clear) |
--image-file-id | string | No | File ID reference when identity_kind=image.; (use "null" or "reset" to clear) |
--notes | string | No | Free-form operator notes for this brand.; (use "null" or "reset" to clear) |
--regex-pattern | string | No | Optional advanced matching regex.; (use "null" or "reset" to clear) |
--offerings | string | No | Customer-visible products, services, solutions, or packages offered by the Brand.; csv |
--audience | string | No | Initial Brand Profile audience composition.; JSON array of objects (use --stdin for large resources) |
--profile-suggestion-decisions | string | No | Body field: profile_suggestion_decisions; (JSON object, e.g. '{"custom_id":"x"}') |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc brand create
Help
orc brands create --helporc brands suggestions list
List brand suggestions
Usage
orc brands suggestions list [flags]Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--status | string | No | enum: pending|accepted|rejected |
--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 brand suggestion-list
Help
orc brands suggestions list --helporc brands suggestions refresh
Generate brand suggestions
Usage
orc brands 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. |
--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 brands suggestions refresh --helporc brands suggestions generations get
Get brand suggestion generation
Usage
orc brands 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 brands suggestions generations get --helporc brands suggestions accept
Accept a brand suggestion
Usage
orc brands 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. |
--edit-name | string | No | Body field: edit_name; max 255 chars |
--relation | string | No | Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored |
See global flags for output and request options. Use --help to check the flags supported by this command.
Help
orc brands suggestions accept --helporc brands suggestions reject
Reject a brand suggestion
Usage
orc brands 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 brands suggestions reject --helporc brands get
Get AI Search brand
Usage
orc brands get <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Brand ID. |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc brand get
Help
orc brands get --helporc brands update
Update AI Search brand
Usage
orc brands update <id> [flags]Arguments
| Argument | Required | Description |
|---|---|---|
id | Yes | Path parameter: id |
Flags
| Flag | Type | Required | Description |
|---|---|---|---|
--name | string | No | Body field: name; max 255 chars |
--domain | string | No | Body field: domain; max 255 chars |
--relation | string | No | Single-axis brand relation. Intent-specific labels can be reserved in tags using intent:* when needed.; enum: owned|direct_competitor|indirect_competitor|ignored |
--tags | string | No | Body field: tags; csv |
--logo-url | string | No | Body field: logo_url; (use "null" or "reset" to clear) |
--display-name | string | No | Body field: display_name; (use "null" or "reset" to clear) |
--industry | string | No | Body field: industry; (use "null" or "reset" to clear) |
--status | string | No | Lifecycle transition. disabled preserves history and stops future execution; returning to active does not backfill the disabled interval.; enum: active|disabled |
--domains | string | No | Body field: domains; csv |
--aliases | string | No | Body field: aliases; csv |
--color-hex | string | No | Body field: color_hex; (use "null" or "reset" to clear) |
--notes | string | No | Body field: notes; (use "null" or "reset" to clear) |
--regex-pattern | string | No | Body field: regex_pattern; (use "null" or "reset" to clear) |
See global flags for output and request options. Use --help to check the flags supported by this command.
Compatibility aliases
orc brand update
Help
orc brands update --helporc brands delete
Soft-delete AI Search brand
Usage
orc brands 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 brand delete
Help
orc brands delete --help