How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
zvid-io

zvid-io Authoring API

Free creative planning and project-authoring helpers

Documentation Provider Profile APIs.io OpenAPI GitHub

zvid-io Authoring API is one of 13 APIs that zvid-io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 6 JSON Schema definitions.

Tagged areas include Authoring. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 8 operations across 8 paths, and defines 50 schemas. It is described by OpenAPI 3.2.0, at version 1.1.0.

Requests are made against a single base URL, https://api.zvid.io.

8 operations 8 paths 50 schemas 5 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1.0
Base URL
https://api.zvid.io
Authentication
API Key, HTTP Bearer
Contact
Zvid Support
Resource Areas
1

Authentication & Security 2

zvid-io Authoring API declares 2 security schemes for authenticating requests. An API key is passed in the header as x-api-key (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth). By default, every request must be authenticated.

  • ApiKeyAuth — API key for authentication. Create one in your dashboard.
  • BearerAuth — Dashboard JWT in Authorization: Bearer , only on operations that explicitly list this scheme. Prefer x-api-key for REST integrations. OAuth for hosted MCP is a…

Paths & Operations 8

Across 8 paths, the API surfaces 8 operations — 5 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Authoring 8

Free creative planning and project-authoring helpers

POST
/api/render/creative-plan/api-key
Plan a creative video
planCreativeVideo body → 200400401500
POST
/api/render/validate/api-key
Validate render request
validateRenderJob body → 200400401404500
GET
/api/render/schema/api-key
Get live render schema
getRenderSchema 1 param → 200400401404500
GET
/api/render/elements/api-key
List supported elements
listRenderElements → 200400401404500
GET
/api/render/elements/{type}/api-key
Get element reference
getRenderElement 1 param → 200400401404500
GET
/api/render/examples/api-key
List authoring examples
listRenderExamples → 200400401404500
GET
/api/render/examples/{name}/api-key
Get authoring example
getRenderExample 1 param → 200400401404500
POST
/api/render/repair/api-key
Repair project JSON
repairRenderProject body → 200400401404500

Schemas 50

The contract defines 50 schemas that model the data the API accepts and returns. The most detailed are VideoVisual (37 properties), ResolvedVideoVisual (36 properties), ImageVisual (26 properties), TextVisual (26 properties). Each schema is shown below with its type and property counts.

ResolvedImageVisual
object
A raster image placed on the canvas.
25 properties 2 required
SvgVisual
object
Inline SVG markup drawn on the canvas.
25 properties 2 required
Filter
object
CSS-like color filters.
7 properties
ExampleResponse
object
4 properties 2 required
ResolvedScene
object
A timeline segment. Scenes play sequentially; a scene's transition blends into the NEXT scene (xfade overlap is subtracted from the total duration).
8 properties
AuthenticationError
object
2 properties 1 required
ExampleList
object
5 properties 2 required
CreativePlanRequest
object
11 properties 1 required
ResolvedGifVisual
object
An animated GIF placed on the canvas (video projects only).
25 properties 2 required
ResolvedVisual
object
One canvas element, discriminated by type (IMAGE | VIDEO | GIF | SVG | TEXT, case-insensitive).
1 required
CreativePlanResponse
object
12 properties 6 required
AudioItem
object
A soundtrack / voice-over entry for audios (video projects only).
11 properties
Visual
object
One canvas element, discriminated by type (IMAGE | VIDEO | GIF | SVG | TEXT, case-insensitive).
1 required
ResolvedFilter
object
CSS-like color filters.
7 properties
Designer
object
Opaque Design Studio round-trip metadata (max 200k chars serialized). Never rendered; keeps 'edit design' working.
CropParams
object
Source crop rectangle in source-media pixels.
4 properties 4 required
ElementReference
object
4 properties 2 required
Scene
object
A timeline segment. Scenes play sequentially; a scene's transition blends into the NEXT scene (xfade overlap is subtracted from the total duration).
12 properties
ValidationResult
object
6 properties 5 required
ResolvedAudioItem
object
A soundtrack / voice-over entry for audios (video projects only).
10 properties
AuthoringSchemaResponse
object
8 properties 4 required
RepairResponse
object
8 properties 5 required
RenderOverrides
object
Output knobs applied after template/variable resolution.
10 properties
Zoom
Ken Burns zoom: true (default 1.2x depth) or { "depth": 1..10 }.
ResolvedCropParams
object
Source crop rectangle in source-media pixels.
4 properties 4 required
ResolvedChromaKey
object
Green-screen keying.
3 properties 1 required
ResolvedRadius
object
Rounded-corner radii in px (tl/tr/bl/br).
4 properties
RenderJobRequest
object
Provide either payload (a full project) or template (a stored template id) — not both.
6 properties
ResolvedVideoVisual
object
A video clip placed on the canvas (video projects only).
36 properties 2 required
VideoVisual
object
A video clip placed on the canvas (video projects only).
37 properties 2 required
ResolvedCustomCode
object
Sandboxed styling/animation code run inside the render browser (Design Studio). No network/filesystem/storage/navigation APIs — see validation notes.
3 properties
ValidationError
object
4 properties 1 required
ChromaKey
object
Green-screen keying.
3 properties 1 required
Error
object
2 properties 1 required
ResolvedDesigner
object
Opaque Design Studio round-trip metadata (max 200k chars serialized). Never rendered; keeps 'edit design' working.
CustomCode
object
Sandboxed styling/animation code run inside the render browser (Design Studio). No network/filesystem/storage/navigation APIs — see validation notes.
3 properties
ElementList
object
6 properties 2 required
Subtitle
object
Burned-in subtitles. Content: EXACTLY ONE of src (SRT/VTT URL) or captions. Style: v2 flat keys (animation/font/stroke/background/...) OR the legacy styles blo…
12 properties
TextVisual
object
Styled text. Provide plain text (no characters) and/or limited html. At least one of text/html must be non-empty.
26 properties 1 required
ResolvedZoom
Ken Burns zoom: true (default 1.2x depth) or { "depth": 1..10 }.
GifVisual
object
An animated GIF placed on the canvas (video projects only).
26 properties 2 required
AuthoringExample
object
5 properties 1 required
ResolvedRenderPayload
object
A project after variable substitution, iteration and conditions. Account-specific ceilings and semantic rules are checked by POST /api/render/validate/api-key.…
18 properties
ImageVisual
object
A raster image placed on the canvas.
26 properties 2 required
ResolvedSubtitle
object
Burned-in subtitles. Content: EXACTLY ONE of src (SRT/VTT URL) or captions. Style: v2 flat keys (animation/font/stroke/background/...) OR the legacy styles blo…
12 properties
Radius
object
Rounded-corner radii in px (tl/tr/bl/br).
4 properties
RenderPayload
object
The payload accepted by render requests and stored templates, before variable substitution, conditions and scene iteration. Whole placeholders preserve the var…
19 properties
ResolvedSvgVisual
object
Inline SVG markup drawn on the canvas.
24 properties 2 required
CreativeBrandKit
object
7 properties
ResolvedTextVisual
object
Styled text. Provide plain text (no characters) and/or limited html. At least one of text/html must be non-empty.
25 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zvid-io-authoring-api-openapi.yml Raw ↑

Other APIs zvid-io publishes across the network.

zvid-io API Keys API
AE Profile APIs.io
zvid-io Bulk Render API
AE Profile APIs.io
zvid-io Credits API
AE Profile APIs.io
zvid-io Library API
AE Profile APIs.io
zvid-io Projects API
AE Profile APIs.io
zvid-io Render API
AE Profile APIs.io
zvid-io Stock API
AE Profile APIs.io
zvid-io Templates API
AE Profile APIs.io
zvid-io Uploads API
AE Profile APIs.io
zvid-io User API
AE Profile APIs.io
zvid-io Webhooks API
AE Profile APIs.io
zvid-io Zvid API
AE Profile APIs.io
#Authoring
← Back to Z APIs
API Details
ID
zvid-io:zvid-io-authoring-api
Base URL
https://api.zvid.io
Docs
https://docs.zvid.io
Provider
zvid-io
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=zvid-io-authoring-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/zvid-io-authoring-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of zvid-io Authoring API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.