Banners

Render a banner again from its plan

Renders a banner again from its plan (output.plan of POST /v1/banner) after you changed it: a word or the price in copy, photo_url (your own picture), brand.logo_url, brand.primary / brand.accent (#RRGGBB), the clips of a video, or style — another style of the same kind (a picture style for a picture, an animated one for a video; the fields the new style does not print are left out). No model call and no picture generation: only the render is charged. Asynchronous like the banner itself: poll GET /v1/executions/{id}.

Billing: The render only · Rate limit: 20/min · Asynchronous

post/v1/banner/render

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/banner/render
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

x-wait-msinteger

Wait for the job inside this call (ms)

Request body

Response

Completed (or 202 while processing)

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

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