Zvid API

Create videos and still images, manage reusable templates and editor projects, and automate render delivery. REST base URL: https://api.zvid.io. Use x-api-key for server-side integrations. Read the schema and run POST /api/render/validate/api-key before rendering: validation is free and returns creditsRequired. A queued render reserves credits and completes asynchronously. Video pricing is ceil(duration seconds) up to 1920×1080 total pixels, or ceil(duration × 4) above that; images cost 1 credit each. Plan-specific limits are enforced by authenticated validation. Browser-safe setup, errors and full workflows: https://docs.zvid.io/docs/quick-start/.

API server

https://api.zvid.io

Endpoint pages show the full path, including /api. Create API keys at app.zvid.io/api-keys. Each operation lists the authentication it accepts.

Choose your next step

• Render your first video
• Render a still image
• Understand project JSON
• Read the OpenAPI specification
• Use documentation with an AI assistant

Operations

• Get user profile: GET /api/user/profile
• Get credit balance: GET /api/credits/balance
• Get transaction history: GET /api/credits/transactions
• Get usage statistics: GET /api/credits/usage-stats
• List API keys: GET /api/api-keys
• Create API key: POST /api/api-keys
• Update API key: PUT /api/api-keys/{id}
• Revoke API key: DELETE /api/api-keys/{id}
• Get API key statistics: GET /api/api-keys/{id}/stats
• Plan a creative video: POST /api/render/creative-plan/api-key
• Submit render job: POST /api/render/api-key
• List render jobs: GET /api/jobs
• Get render job status: GET /api/jobs/{id}
• Submit image render job: POST /api/render/image/api-key
• Submit bulk render: POST /api/render/bulk/api-key
• Submit bulk image render: POST /api/render/image/bulk/api-key
• List bulk renders: GET /api/render/bulk
• Get bulk render status: GET /api/render/bulk/{id}
• List templates: GET /api/templates
• Create template: POST /api/templates
• Get template: GET /api/templates/{id}
• Update template: PUT /api/templates/{id}
• Archive template: DELETE /api/templates/{id}
• Resolve and validate template: POST /api/templates/{id}/preview
• List webhooks: GET /api/webhooks
• Create webhook: POST /api/webhooks
• Get webhook: GET /api/webhooks/{id}
• Update webhook: PUT /api/webhooks/{id}
• Delete webhook: DELETE /api/webhooks/{id}
• List webhook deliveries: GET /api/webhooks/{id}/deliveries
• Send test delivery: POST /api/webhooks/{id}/test
• List uploads: GET /api/uploads
• Upload a file: POST /api/uploads
• Delete upload: DELETE /api/uploads/{id}
• List projects: GET /api/projects
• Create project: POST /api/projects
• Get project: GET /api/projects/{id}
• Update project: PUT /api/projects/{id}
• Delete project: DELETE /api/projects/{id}
• Duplicate template: POST /api/templates/{id}/duplicate
• Validate render request: POST /api/render/validate/api-key
• Get live render schema: GET /api/render/schema/api-key
• List supported elements: GET /api/render/elements/api-key
• Get element reference: GET /api/render/elements/{type}/api-key
• List authoring examples: GET /api/render/examples/api-key
• Get authoring example: GET /api/render/examples/{name}/api-key
• Repair project JSON: POST /api/render/repair/api-key
• Get MCP preferences: GET /api/mcp/preferences
• Search stock media: GET /api/stock/search
• List creative library items: GET /api/library/{kind}
• Get creative library metadata: GET /api/library/{kind}/{slug}
• Get creative library content: GET /api/library/{kind}/{slug}/content