Spark IQ

Search this server's videos

Search the marketing videos this server has rendered, by domain, brand, campaign, product name, hook, status or id. Returns {results:[{id,title,url}]} — pass an id to `fetch` for the full record. Also returns a capability overview document, so a query that matches nothing still explains what this server does.

Fetch a full record by id

Retrieve the complete record for an id returned by `search` — or any id this server issued (requestId req_…, videoId vid_…, domainId dom_…). For a video this is the whole content description: brand, video facts and checksum, every scene with timecodes, every product, the on-screen copy and the provenance.

Create a marketing video for a domain

Trigger the automated pipeline: give a target URL (the storefront domain) and 1-10 product images, get back a rendered SparkIQ marketing video. Returns domain-based ids immediately (domainId, requestId, triggerId, videoId, callbackId) and renders in the background — poll get_video_status or register a callbackUrl. Identical input to the same domain is idempotent and returns the existing request instead of rendering twice.

Get render status

Current status of a video job by requestId, triggerId or videoId: phase, progress, recent events, and the result summary once it is done.

Get the finished video

The saved video for a completed request: public URL, local path, sha256, duration, resolution, poster and manifest URLs. Returns ready:false with the current phase if the render is still running.

Describe what is inside the video

Scene-by-scene beat sheet with timecodes, the on-screen copy, every product and where it appears, the palette, and provenance (what was scraped, derived or supplied). Use this to answer questions about a video without downloading it.

List videos for a domain

Every video request for one domain, newest first. Call with no arguments to list all domains this server has rendered for.

Register (or replace) a completion callback

Attach a callback URL to an existing request and get its callbackId. If the video is already finished, the callback fires immediately.

Re-deliver a callback

Re-send the completion payload for a request — to a specific callbackId, or to every callback registered on it. Use after a receiver outage.

Cancel a render

Stop a queued or in-flight render. Completed videos are left alone.

Resolve a URL to its domain identity

Normalise any URL to its domain and deterministic domainId, and report how many videos already exist for it. Cheap; makes no network calls.

Server health and limits

Service version, public base URL, configured limits and policy, queue depth and store statistics.