Effects · Text animations

Kinetic typography cards · טיפוגרפיה קינטית

1–3 spoken words per card in rotating display fonts and colours, each card replacing the last on the word.

1–3 מילים בכל כרטיס, גופן וצבע מתחלפים, כל כרטיס מחליף את הקודם בדיוק על המילה.

One effect, one render: send the video (or nothing, for the canvas), the effect's params and when it plays (start + duration seconds, or at / during words) — every field has a default. The same effect stacks with others in effects of POST /v1/studio/edit. Preview: GET /v1/effects/kinetic-cards.

Billing: Per second of output, like /v1/studio/edit — the effect is burned into the same render (+ transcription seconds when a captions effect transcribes automatically). A heavy effect (one that adds render time — measured) adds effect seconds: the seconds it is on screen × its weight, priced like output seconds; GET /v1/effects/{id} states its weight and price. Failed renders are not charged. · Rate limit: 30/min · Asynchronous

post/v1/effects/kinetic-cards

Request

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

startnumber

seconds on the output — when it starts (default: the effect's own)

durationnumber

seconds — how long it lasts

video_urlstring uri

The video (required)

language_codestring

Spoken language for the automatic transcript, e.g. he, en

transcript_idstring

Reuse a transcript (captions effects)

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.