Getting started

topics

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

Commands

  • orc topics list — List AI Search topics in project
  • orc topics create — Create AI Search topic
  • orc topics get — Get AI Search topic
  • orc topics update — Update AI Search topic
  • orc topics delete — Soft-delete AI Search topic
  • orc topics suggestions list — List topic suggestions
  • orc topics suggestions refresh — Generate topic suggestions
  • orc topics suggestions generations get — Get topic suggestion generation
  • orc topics suggestions accept — Accept a topic suggestion (promote to topic)
  • orc topics suggestions reject — Reject a topic suggestion

orc topics list

List AI Search topics in project

Usage

orc topics list [flags]

Flags

FlagTypeRequiredDescription
--brand-idstringNoOptional AI Search Brand ID filter.
--limitnumberNoMaximum number of items to return
--cursorstringNoOpaque 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 topic list

Help

orc topics list --help

orc topics create

Create AI Search topic

Usage

orc topics create [flags]

Flags

FlagTypeRequiredDescription
--idempotency-keystringNoUnique 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.
--namestringNo(required) Topic name.; max 255 chars
--brand-idstringNoOptional brand association. Required by the current storage model until nullable project-only topics are enabled.

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

Help

orc topics create --help

orc topics get

Get AI Search topic

Usage

orc topics get <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

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

Compatibility aliases

  • orc topic get

Help

orc topics get --help

orc topics update

Update AI Search topic

Usage

orc topics update <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--namestringNoBody field: name; max 255 chars

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

Compatibility aliases

  • orc topic update

Help

orc topics update --help

orc topics delete

Soft-delete AI Search topic

Usage

orc topics delete <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

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

Compatibility aliases

  • orc topic delete

Help

orc topics delete --help

orc topics suggestions list

List topic suggestions

Usage

orc topics suggestions list [flags]

Flags

FlagTypeRequiredDescription
--statusstringNoenum: pending|accepted|rejected
--brand-idstringNovalue
--limitnumberNoMaximum number of items to return
--cursorstringNoOpaque 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 topic suggestion-list

Help

orc topics suggestions list --help

orc topics suggestions refresh

Generate topic suggestions

Usage

orc topics suggestions refresh [flags]

Flags

FlagTypeRequiredDescription
--idempotency-keystringNoUnique 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.
--waitbooleanNoWait for an asynchronous operation to finish and print its result
--timeoutstringNoMaximum wait duration (for example 30s or 5m)
--poll-intervalstringNoDelay 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 topics suggestions refresh --help

orc topics suggestions generations get

Get topic suggestion generation

Usage

orc topics suggestions generations get <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

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

Help

orc topics suggestions generations get --help

orc topics suggestions accept

Accept a topic suggestion (promote to topic)

Usage

orc topics suggestions accept <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--idempotency-keystringNoUnique 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.
--brand-idstringNoOverride target brand
--edit-namestringNoBody field: edit_name; max 255 chars

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

Help

orc topics suggestions accept --help

orc topics suggestions reject

Reject a topic suggestion

Usage

orc topics suggestions reject <id> [flags]

Arguments

ArgumentRequiredDescription
idYesPath parameter: id

Flags

FlagTypeRequiredDescription
--idempotency-keystringNoUnique 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 topics suggestions reject --help