Projects, requests, templates and jobs

A Zvid integration turns a project into an output through a render job. Keep the project data, submission request and job result separate in your code.

Term	Meaning	Where to find it
Project	The composition: output size, visual elements, audio, scenes and subtitles	The payload field of a render request; project reference
Element	One image, text block, clip or other item	A visuals or audios array, or subtitle configuration
Scene	A sequential segment with its own local timeline	payload.scenes[]; scene reference
Request envelope	The object POSTed to the render API	payload or template, plus variables, overrides and supported request options
Template	A saved reusable project with variable defaults	An owned tpl_… ID; template guide
Variables	Values substituted into a project	Defaults inside the project; request-time values in the envelope
Override	A supported output setting applied for a submission	Envelope overrides, not an arbitrary deep patch of an element
Preview	For template API calls, free resolution and validation	Returns a resolved project and stats, not rendered media
Render job	One asynchronous operation producing media	Submission jobId; lookup GET /api/jobs/{id}
Bulk batch	A group of individual render jobs	One design with many variable sets; bulk guide
Editor draft	A saved, editable composition	A prj_… project and an editor link
Output	Completed video or image	A completed job's result URL

Choose a route

• One-off JSON: send a complete project under payload.
• Reusable design: create a template, preview its variables, then render its template ID with the desired values.
• Many personalized outputs: use bulk rendering within the account's batch limit.
• Interactive AI creation: connect the MCP server and use the selected profile's draft/approval workflow.
• Visual authoring: build in the editor, then validate against the hosted API before automating the exported JSON.

Read an example at the right level

An element fragment describes one item. Place it in the named array of a project. A project payload describes the composition but still needs the payload request wrapper. A complete request includes that wrapper and can be submitted once credentials and referenced assets are configured.

For a complete first request and rendered output, follow Quick Start. Then read layout, timing, and validation before combining features.