Creatives

/creatives/generations/{generation_id}

Reports on a generation started by /creatives/generate.

Poll until status stops being running; on succeeded, read the creative at creative_id for its formats. There is no progress percentage — the pipeline has no meaningful one to give.

Requires the creatives:read scope.

get/projects/{project_id}/creatives/generations/{generation_id}

Request

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

Path parameters

project_idstring required

The project the generation belongs to.

generation_idstring required

The generation to read.

Response

The generation.

idstring required

Pass this to /creatives/generations/{generation_id} to follow it.

creative_idstring required

The creative being generated into. It exists from the moment the generation starts, empty until the first result lands, so you can reference it before the work finishes.

status'running' | 'succeeded' | 'failed' required

running until it settles. On succeeded, read the creative for its formats.

error_codestring

Why it failed. A stable code, never prose.

created_atstring date-time required

When the generation was started.

updated_atstring date-time required

When it last changed.

Changes

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