Skip to main content
POST
Upload Background or Foreground

Authorizations

x-simli-api-key
string
header
required

Path Parameters

kind
enum<string>
required
Available options:
backgrounds,
foregrounds

Body

multipart/form-data
image
file
required

JPEG, PNG or WEBP, under 5MB, in one of the streaming canvases' shapes: 16:9, 9:16 or 1:1 and no other, at least 512 pixels on its shorter side and at most 1920x1080, 1080x1920 or 1080x1080. A foreground needs transparency (a PNG or WEBP with an alpha channel). EXIF orientation is applied; metadata is dropped.

Response

Stored

id
string<uuid>
required

What background_id / foreground_id and BG_ / FG_ take.

name
string
required

The uploaded file's name.

width
integer
required
height
integer
required
size_bytes
integer
required

The stored PNG's size.

created_at
integer
required

Unix time, in seconds.