​

topics

orc topics manages monitoring topics associated with brands. Retrieve lists and details, create or change names, archive or unarchive topics, and soft-delete them. Review topic candidates generated from Workspace brand information before accepting or rejecting them.

Configure authentication and select the target Workspace. Creation requires a topic name and a brand ID in that Workspace. Creating a topic does not create prompts. Attach subsequent questions through topic_id in orc prompts.

Inspect saved topics.

List topics under non-deleted brands newest first, including archived topics. Omit --brand-id to include all brands. Preserve the brand filter while following pages.

Restrict results to this brand in the selected workspace. Omit to include all brands; an unavailable brand returns 404.

Type: string. Optional.

name is limited to 255 characters and required together with brand_id. New topics are unarchived. Requires workspace:settings permission.

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.

Type: string. Optional.

(required) Human-readable topic name, from 1 to 255 characters.; max 255 chars

Type: string. Optional.

(required) Required parent brand in the selected workspace. A topic cannot currently be created without a brand.

Type: string. Optional.

Create a topic for a brand

Retrieve details by topic ID, including archived topics. Return 404 if the topic or parent brand is unavailable in the target Workspace.

Change only supplied name and archived. --archived true archives; false unarchives. The brand association cannot be changed here. An empty body returns the current topic.

Set true to archive or false to unarchive through the measurement lifecycle. Omit to keep the current state.

Type: string. Optional.

Replacement topic name. Omit to keep the current name.; max 255 chars

Type: string. Optional.

Archive a topic

Soft-delete a topic through the measurement lifecycle and hide it from ordinary lists and reads. Requires workspace:settings permission.

Filter stored suggestions with --status and --brand-id. Omitted filters do not restrict results. Preserve filters while following cursors.

Filter by suggestion status. Omit to include all statuses.; enum: pending|accepted|rejected

Type: string. Optional.

Filter by brand id in the selected workspace. Omit to include domains or suggestions for all brands.

Type: string. Optional.

Start asynchronous suggestion generation from the current Workspace’s brand context. No body is needed. Use --wait to wait for completion. Generated candidates do not become topics until explicitly accepted.

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.

Type: string. Optional.

Generate topic suggestions and wait

Retrieve asynchronous generation status by returned generation ID. Check state rather than treating acceptance as completion.

Accept a pending candidate and create an active topic. --brand-id overrides the suggestion’s brand. If neither provides a brand, return 400. Adjust the name with --edit-name. Resolved suggestions return 409; missing IDs return 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.

Type: string. Optional.

Brand in the selected workspace to assign to the new topic. Required when the suggestion has no brand.

Type: string. Optional.

Name for the created resource. When omitted, uses the suggestion name.; max 255 chars

Type: string. Optional.

Mark a pending candidate rejected. Missing IDs return 404; already accepted or rejected suggestions return 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.

Type: string. Optional.

Access to the target Workspace is required. Changes require the corresponding write permissions.

The following global options can be used with orc topics:

For details and examples, see global options.