Creatives

/creatives/upload

Creates a creative from media you supply. Send multipart/form-data with a file field: a JPEG, PNG, WebP, HEIC, or HEIF image, or an MP4 video.

For a video, also send width and height in pixels, and optionally duration_seconds. Images are measured for you; a video cannot be, and the frame size decides how the creative renders — so an MP4 without them is rejected rather than guessed at.

This is one of the ways to create a creative — see /creatives/generate for the other. Either way the returned id is a creative id, reusable as creative_id on as many posts as you like.

Send an Idempotency-Key header so a retry after a timeout collects the original creative instead of uploading the file a second time.

Requires the creatives:write scope.

post/projects/{project_id}/creatives/upload

Request

  • Base URL: https://api.productbyte.com/v1
  • URL: https://api.productbyte.com/v1/projects/{project_id}/creatives/upload
  • Auth: HTTP bearer

Path parameters

project_idstring required

The project to create the creative in.

Response

The creative was created.

idstring required

Pass this as creative_id when creating a post.

namestring required

What the creative is called in ProductByte.

kind'image' | 'carousel' | 'video' required

What the creative is built from. It decides what formats means — see below.

created_atstring date-time required

When the creative was created.

Changes

No recorded changes to this operation across all 2 revisions of this API.