View images
Look at images: creatives in the brand's library, or image urls from the web.
Tool name: view-images.
Look at images: creatives in the brand's library, or image urls from the web. They are shown to you after this call. Images from the web are copied to Koast storage first, and the copy's url can be used in render-creative html. Read-only for the library.
When to use
See a reference before you remix it, look again at a creative to check its words, logo, colours and layout, or compare versions side by side. Up to 12 images per call.
Access
| Property | Value |
|---|---|
| Required scope | read |
| Publishes | No |
| Read-only | Yes |
| Destructive | No |
| Idempotent | Yes |
| Open world | Yes |
Input
| Field | Type | Required | Description |
|---|---|---|---|
creativeIds | integer[] | No | Creatives in the brand's library to look at. At most 8 items. |
urls | string (uri)[] | No | Image urls to look at, such as imageUrls from search-ad-library or search-inspiration. Each is copied to Koast storage first. At most 8 items. |
Output
| Field | Type | Required | Description |
|---|---|---|---|
images | object[] | Yes | |
failures | object[] | Yes | Images that could not be shown, with why. |
modelImages | object[] | No | Images shown to you after this call. At most 12 items. |
REST equivalent
GET /v1/brands/{brandId}/image-views, View images. CLI: koast view-images.
Upload creative
Store an image in the active brand's creative library and return its creativeId, ready to put in an ad with add-ads, distribute-creative or swap-creatives.
Search inspiration
Search Pinterest or Cosmos for images to use as visual references: a style, a composition, a mood, a kind of product shot.