Skip to main content

Introduction

Welcome to the Zvid API Documentation! This API allows you to programmatically create and manage video rendering jobs, monitor your credit usage, and manage API keys.

What is Zvid?​

Zvid is a powerful video rendering platform that allows you to create professional videos programmatically. With the Zvid API, you can:

  • 🎬 Render videos with custom visuals, subtitles, text, images, and audio
  • 💳 Manage credits and monitor your usage
  • 🔑 Create and manage API keys for secure access
  • 📊 Track statistics for your rendering jobs
  • 👤 Access your profile and account information

Quick Start​

Get started with the Zvid API in three simple steps:

1. Create an API Key​

First, you'll need to create an API key from the Zvid Dashboard:

  1. Log in to your Zvid account
  2. Click the API Access box at the bottom right corner.
  3. Click Create API Key at the top right corner.
  4. Give your key a descriptive name (e.g., "Production API")
  5. Copy and save the key securely - you won't be able to see it again!

2. Make Your First Request​

Use your API key to make requests to the API:

curl -X GET https://api.zvid.io/api/user/profile \
  -H "x-api-key: your-api-key-here"

3. Start Rendering Videos​

Submit your first render job:

curl -X POST https://api.zvid.io/api/render/api-key \
  -H "x-api-key: your-api-key-here" \
  -H "Content-Type: application/json" \
  -d '{
    "payload": {
      "width": 1920,
      "height": 1080,
      "duration": 10,
      "backgroundColor": "#000000",
      "visuals": [
        {
          "type": "TEXT",
          "text": "Hello, Zvid!",
          "x": 960,
          "y": 540
        }
      ]
    }
  }'

What's Next?​

Need Help?​

  • Support: Contact us at help@zvid.io
  • Issues: Report bugs or request features through our support portal
  • Community: Join our community forum for tips and best practices

API Base URL​

All API requests should be made to:

https://api.zvid.io