View images

Returns viewable copies of library creatives (creativeIds) and web images (urls). Web images are fetched, shrunk to at most 1568 pixels on the long side and stored on Koast storage; private and internal addresses are refused.

GET

/v1/brands/{brandId}/image-views

Authorization

bearerAuth

headerAuthorizationBearer <token>

An organization API key (koast_sk_…) with the API surface enabled, or an OAuth access token issued by Koast (koast_at_…) whose audience covers this API. REST access requires an active Agency plan.

Path Parameters

brandId*integer

The brand the request acts on. Every brand-scoped resource lives under its brand.

Query Parameters

creativeIds?array<>

Creatives in the brand's library to look at.

Itemsitems <= 8

urls?array<>

Image urls to look at, such as imageUrls from search-ad-library or search-inspiration. Each is copied to Koast storage first.

Itemsitems <= 8

Response Body

View images

application/json

response

images*array<>

failures*array<>

Images that could not be shown, with why.

modelImages?array<>

Images shown to you after this call

Itemsitems <= 12

[key: string]?unknown

curl -X GET "https://example.com/v1/brands/0/image-views" \  -H "Authorization: Bearer koast_sk_..."

{  "images": [    {      "label": "string",      "url": "string",      "width": 0,      "height": 0,      "property1": null,      "property2": null    }  ],  "failures": [    {      "label": "string",      "reason": "string",      "property1": null,      "property2": null    }  ],  "modelImages": [    {      "url": "string",      "label": "string",      "property1": null,      "property2": null    }  ],  "property1": null,  "property2": null}

Required scope: read. CLI: koast view-images, see Image Views commands. Authentication, headers, errors and pagination work the same on every operation. See Conventions.