Images

Publish a library image, optionally at a scheduled time

Publishes the image immediately, or — when published_at is a future time — schedules it (capped at 28 days from now; beyond that, or in the past, returns 422). Omit the body to publish now.

post/api/v1/images/{id}/publish

Request

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

Path parameters

idstring required

image ID

Request body

published_atstring date-time

ISO 8601 time to publish. A future time schedules the image (capped at 28 days from now; beyond that, or in the past, returns 422). Omit to publish now.

Response

Published 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.