Effects

List effects

Every effect of the library with its names (Hebrew and English), category, one line, inputs, timing, params (JSON schema with defaults and ranges), its real preview (video and poster) and its price per second of output. Order one with POST /v1/effects/{id}, or stack several in the effects array of /v1/studio/edit and /v1/studio/short. coming lists the effects of the next phase (drawn in a browser): no endpoint until they are switched on.

Billing: Read request — free · Rate limit: 120/min

get/v1/effects

Request

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

Query parameters

category'text' | 'transition' | 'camera' | 'look' | 'overlay' | 'layout' | 'audio' | 'speed'

Only this category

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=…

Response

Completed

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.