CLI commands
Copies commands
The 2 koast CLI commands for the Copies operations.
Every command is one API operation, named by its operationId. Global flags such as --output and --api-url work on all of them, see CLI commands.
generate-copy
Generate ad copy. POST /v1/brands/{brandId}/copies, API reference.
koast generate-copy --brand <brand> --platform <platform> [--json <file|->] [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--platform | string | Yes | Target platform. Only facebook and instagram are supported, the value is stored as the copy's platform label. One of facebook, instagram. |
--tone | string | No | Tone: professional, casual, urgent, friendly. Optional, defaults to brand voice. |
--angle | string | No | Marketing angle. Optional, only pass if the user requested a specific framing. |
--product-description | string | No | Optional override. Backend auto-fills product context from brand (name, URL, business type, voice). Only pass this if the user gave specifics that should take precedence over brand defaults. |
--creative-ids | number, repeatable | No | IDs of creatives attached to this chat. When present, the backend pulls each creative's name + stored visual analysis and feeds it to the copy LLM so the copy matches what the ad actually shows. Pass whenever creatives are listed in the ## Attachments block. Never call readDocument on image MIME types, use this param instead. |
Required scope: write. Accepts --idempotency-key. The CLI sends a key only when you give one. --json <file|-> supplies the whole body. Body flags are applied over it.
Example:
koast generate-copy --brand 123 --platform facebookget-copy
Get generated ad copy. GET /v1/brands/{brandId}/copies/{copyId}, API reference.
koast get-copy --brand <brand> --copy-id <copy-id>| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--copy-id | string | Yes | ID of the copy generation |
Required scope: read.
Example:
koast get-copy --brand 123 --copy-id COPY_ID