Effects · Overlays & graphics

Map route · מסלול על מפה

A route draws itself between two places on a stylised map (drawn in code, or your own map picture), a pin, a plane or a car riding it.

מסלול מצטייר בין שני מקומות על מפה מסוגננת (מצוירת בקוד, או תמונת מפה משלך), עם סיכה, מטוס או מכונית שנוסעים עליו.

Drawn by a browser inside the render (an HTML scene), then composited like any overlay — the same job as any edit. 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. Details: GET /v1/effects/map-route.

Billing: Per second of output, like /v1/studio/edit, plus effect seconds: the seconds the scene is on screen × its measured weight (a browser draws every frame), priced like output seconds — GET /v1/effects/{id} states it. Failed renders are not charged. · Rate limit: 30/min · Asynchronous

post/v1/effects/map-route

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/effects/map-route
  • 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 to put it on — leave out for the plain canvas

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.