CLI commands
Reference Library commands
The 1 koast CLI command for the Reference Library 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.
search-reference-library
Search the reference library. GET /v1/brands/{brandId}/reference-library, API reference.
koast search-reference-library --brand <brand> [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--brief | string | No | What the brand sells, to whom, and how its ads should look, in a few sentences. The ads closest to it come back. Defaults to the brand's saved style guide. At most 1200 characters. |
--format | string | No | The layout device the ad is built on. Only ads with this format come back. One of native_mockup, quiz_or_form, event_webinar, lead_magnet_mockup, before_after, comparison, problem_solution, advertorial, meme, note_or_letter, testimonial_quote, founder_expert, offer_banner, big_number, feature_callout, infographic, listicle, product_ui_screen, collection_grid, ugc_photo, text_statement, scene_photo, product_hero, other. |
--exclude-risk-flags | string, repeatable | No | Leave out ads carrying any of these policy risks. One of before_after_body, health_claim, income_claim, named_competitor, third_party_logos, government_lookalike, fake_ui_element, personal_attribute_callout, shock_imagery, money_imagery. At most 10 items. |
--min-tier | string | No | Lowest winner tier to include. Defaults to STRONG. One of TOP, STRONG, AVERAGE. |
--limit | integer | No | Ads to return, 1-12. Defaults to 4. Fewer come back when few are close to the brief. Minimum 1, maximum 12. |
Required scope: read.
Example:
koast search-reference-library --brand 123