Carousel

Re-render a carousel from its plan

Renders slides again from a plan (output.plan of POST /v1/carousel) after you changed it: a word, a headline, a colour, the font, or one slide's image_url (your own picture; remove the field for a brand-colour card). No model call, no picture search or generation — only the render is charged. only: [3] renders just slide 3; it keeps its place in the carousel (the marker still says 3/7 and the layout matches the other slides). The shape is the plan's own aspect (a plan without one — made before the square — is 4:5); send aspect to render the whole carousel in the other shape (not together with only: a carousel has one shape; a picture is cropped to the new shape around its middle, or around focus_x / focus_y of its slide). The limits of the shape apply: 1:1 — headline ≤ 6 words and 44 characters, body ≤ 18 words and 120 characters; 4:5 — headline ≤ 8 words, body ≤ 25 words; at most 5 hashtags. A picture that is not already on our storage is downloaded first (public addresses only; JPEG, PNG or WebP). swipe_cue: false leaves out the swipe cue next to the marker — slides shown inside a video, where nobody swipes. Asynchronous like the carousel itself: poll GET /v1/executions/{id}.

Billing: The render only: one image unit per slide rendered · Rate limit: 20/min · Asynchronous

post/v1/carousel/render

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/carousel/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

onlyinteger[]

Render only these slides (1-based), e.g. [3]; default: all

aspect'1:1' | '4:5'

Render the plan in this shape (1:1 or 4:5) instead of its own — the whole carousel, so leave only out. Default: the plan's aspect (a plan without one is 4:5). The text limits of the shape apply.

swipe_cueboolean

The swipe cue next to the slide marker ("Swipe", "החליקו"); false = the marker alone — slides shown inside a video, where nobody swipes

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.