Images

Upload an image

Upload a single image to your company's image library and get back a permanent public URL you can use in emails. Images are stored in an "API Uploads" folder at the root of the image library, visible to every brand.

Accepted formats are PNG, JPEG, WebP, HEIC and HEIF, up to 5MB and 4096 pixels on the longest side.

Uploading a file identical to one your company uploaded through the API in the last 30 days returns the existing image with a 200 instead of storing a copy, so retrying a failed or timed-out upload is safe. A new image returns a 201.

Uploads are limited to 30 requests per minute per user and 1,000 per day per company. Every request counts toward both limits, including re-uploads of an existing image and requests that fail validation.

post/images

Request

Base URL
https://enterprise.knak.io/api/published/v1
Auth
none declared
TypeScript
https://skmtc.dev/knak/apis/knak-enterprise-api/docs/images/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body multipart/form-data

imagestring binary required

The image file to upload.

Response

An identical image was uploaded in the last 30 days; the existing image is returned.

Example response

{
  "data": {
    "type": "image",
    "id": "6a1f2c3d4e5b6",
    "attributes": {
      "name": "banner.png",
      "url": "https://cdn.example.com/banner.png"
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.