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

zvid-io Projects API

Editor draft projects (open them in the visual editor)

zvid-io Projects 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 Project. The published artifact set on APIs.io includes an OpenAPI specification and 6 JSON Schemas.

This API exposes 5 operations across 2 paths, and defines 24 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.

5 operations 2 paths 24 schemas 1 DELETE2 GET1 POST1 PUT

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
Resource Areas
1

Authentication & Security 2

zvid-io Projects 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 5

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

Projects 5

Editor draft projects (open them in the visual editor)

GET
/api/projects
List projects
listProjects 2 params → 200401
POST
/api/projects
Create project
createProject body → 201400401
GET
/api/projects/{id}
Get project
getProject 1 param → 200400401404
PUT
/api/projects/{id}
Update project
updateProject 1 param body → 200400401404
DELETE
/api/projects/{id}
Delete project
deleteProject 1 param → 200401404

Schemas 24

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

SvgVisual
object
Inline SVG markup drawn on the canvas.
25 properties 2 required
Filter
object
CSS-like color filters.
7 properties
ProjectSummary
object
One project as returned by the project list endpoint (no project JSON — fetch the project by ID for that).
7 properties 4 required
AuthenticationError
object
2 properties 1 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
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
ProjectList
object
2 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
Zoom
Ken Burns zoom: true (default 1.2x depth) or { "depth": 1..10 }.
VideoVisual
object
A video clip placed on the canvas (video projects only).
37 properties 2 required
ValidationError
object
4 properties 1 required
ChromaKey
object
Green-screen keying.
3 properties 1 required
Error
object
2 properties 1 required
CustomCode
object
Sandboxed styling/animation code run inside the render browser (Design Studio). No network/filesystem/storage/navigation APIs — see validation notes.
3 properties
Pagination
object
Standard pagination envelope for list endpoints.
6 properties 4 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
GifVisual
object
An animated GIF placed on the canvas (video projects only).
26 properties 2 required
ImageVisual
object
A raster image placed on the canvas.
26 properties 2 required
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
Project
object
An editor draft project, including its full project JSON. Open it in the visual editor at https://editor.zvid.io?project= .
8 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs zvid-io publishes across the network.

zvid-io API Keys API
zvid-io Authoring API
zvid-io Bulk Render API
zvid-io Credits API
zvid-io Library API
zvid-io Render API
zvid-io Stock API
zvid-io Templates API
zvid-io Uploads API
zvid-io User API
zvid-io Webhooks API
zvid-io Zvid API
Where this information came from

This is an independent, third-party profile of zvid-io Projects 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.