Upload artwork
advertiser.artwork.uploadUpload the advert artwork from a public https image URL (PNG or JPEG) or base64. It is converted to the screen's 800 × 480 e-paper format in the 1,307 Wall Marketing colours (solid, no dithering), with a six-colour version for screens on older firmware (render), and checked for nudity and profanity. Returns a creative_id and an image of what the screen will show. Photos work; large, high-contrast words read best from a distance.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| fit | No | cover crops to fill (default), stretch distorts to fill. | |
| name | No | A name to recognise the artwork by. | |
| render | No | The six-colour version, for screens on firmware before 0.16.0 only: bold (default): solid colours (graphics, text); smooth: dithered (photos); auto picks from the image. Every upload is also converted to the 1,307 colours. | |
| image_url | No | https:// address of a PNG or JPEG, up to 10 MB. | |
| image_base64 | No | The PNG or JPEG file as base64, if there is no URL. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | The creative_id to book with. | |
| name | No | The name given at upload. | |
| error | No | Present instead of the other fields when the call failed. | |
| checks | No | What was checked. | |
| object | No | Always "creative". | |
| render | No | bold or smooth: how the image was converted to the panel's colours. | |
| source | No | How it arrived: image, or a ready-made panel file. | |
| status | No | Always "approved": artwork that fails the checks is refused at upload. | |
| livemode | No | False in the sandbox. | |
| created_at | No | When it was uploaded. ISO 8601, UTC. | |
| preview_url | No | PNG of exactly what the screen will show. | |
| original_type | No | The uploaded file's type. |