---
title: "Create Image Asset"
method: POST
path: "/api/v1/image-assets"
tags: ["Image Assets"]
---

# Create Image Asset

`POST /api/v1/image-assets`

Create a new image asset to be used in pass templates

## Request body

- ImageAsset
  - `imageAsset` object
    - `name` string, nullable — Name of the image asset. Maximum 255 characters. Must be unique within the same entity if provided
    - `imageType` 'banner' | 'logo' | 'thumbnail' | 'artwork' | 'secondaryLogo' | 'venueMap', required — Type of the image asset
    - `image` string, required — Direct HTTPS image URL or base64 encoded data URI. Supported formats: PNG, JPG, WebP
    - `entityId` string — UUID of the target entity. Only required for organisation-level API keys. Entity-level API keys automatically use their scoped entity
    - `watermark` object — Watermark configuration. Only allowed when imageType is banner. Required for banner images when watermarking is enabled for your organisation
      - `color` 'dark' | 'light', required — Watermark colour
      - `position` 'bottomLeft' | 'bottomRight' | 'topLeft' | 'topRight', required — Watermark position on the image

## Response `201`

Image asset created successfully

- SerializedImageAsset
  - `data` object
    - `id` string — ID of the image asset
    - `type` string — Resource type
    - `attributes` object
      - `name` string — Name of the image asset
      - `imageType` 'banner' | 'logo' | 'thumbnail' | 'artwork' | 'secondaryLogo' | 'venueMap' — Type of the image asset
      - `processingStatus` 'pending' | 'successful' | 'failed' — Current processing status of the image asset
      - `size` object
        - `width` integer — Width of the image asset
        - `height` integer — Height of the image asset
      - `entityId` string — UUID of the entity this image asset belongs to
      - `createdAt` string — Timestamp of when the image asset was created
      - `url` string — URL of the original image. This URL may change over time, so do not store or cache it. Always fetch the latest URL from the API when needed.
      - `watermark` object, nullable — Watermark configuration. Only present for banner image assets when watermarking is enabled
        - `color` 'dark' | 'light' — Watermark colour
        - `position` 'bottomLeft' | 'bottomRight' | 'topLeft' | 'topRight' — Watermark position on the image

## Other responses

- `401` — Error: Unauthorized
- `422` — Error: Unprocessable Entity

---

[API](https://skmtc.dev/passentry/apis/passentry-api.md) · [All operations](https://skmtc.dev/passentry/apis/passentry-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/passentry/passentry-api/revisions/3b24e067f9d9/schema)