Images

Create a library image

Adds an image to the business's library. Provide the source exactly one of three ways: s3_key (after a direct-to-S3 upload via createImageUploadSignature), url (the server fetches it), or inline file_base64 (short images only, ≤5MB decoded). Attach products in one call via the ordered products array (order sets product_sort_position). Requires the images feature.

post/api/v1/images

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/images
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: images:write)

Request body

OR
OR

Response

Created image

accessstring

Visibility: "public", "private" or "unlisted"

idstring
formatstring
descriptionstring nullable
titlestring
widthinteger nullable
sourcestring

social_media, aigc or api

urlstring nullable

Full-resolution CDN URL of the original file.

localestring nullable
hashtagsstring[]
published_atstring date-time nullable

When the image is/was published; null for a draft. A future value is scheduled.

file_sizeinteger nullable
updated_atstring date-time
created_atstring date-time
heightinteger nullable
badgestring nullable

e.g. "ad"

archived_atstring date-time nullable
is_publishedboolean

Whether the image is currently published (published_at set and not in the future); evaluated at request time.

blur_hashstring nullable
folder_idstring nullable

Changes

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