CLI commands
Inspiration commands
The 1 koast CLI command for the Inspiration 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-inspiration
Search inspiration. GET /v1/brands/{brandId}/inspiration, API reference.
koast search-inspiration --brand <brand> --source <source> --query <query> [flags]| Flag | Type | Required | Description |
|---|---|---|---|
--brand | integer | Yes | The brand the request acts on. Every brand-scoped resource lives under its brand. |
--source | string | Yes | pinterest for a wide pool of everyday and product imagery; cosmos for curated, design-led images (editorial, branding, type, art direction). One of pinterest, cosmos. |
--query | string | Yes | What to look for, in a few words: a style, a subject, a mood or a kind of ad ("minimal skincare flat lay", "bold typographic poster"). At most 200 characters. |
--limit | integer | No | Images to return, 1-30. Defaults to 12. Minimum 1, maximum 30. |
--cursor | string | No | nextCursor from the previous page of the same search. At most 500 characters. |
Required scope: read. Paged. --all follows nextCursor to the end and prints one JSON line per item.
Example:
koast search-inspiration --brand 123 --source pinterest --query QUERY