Documentation

Quick Start

Get started with the Veedeo API in minutes. This guide will walk you through creating your first video render using our V3 API.

Prerequisites

  • A Veedeo account with API access
  • Your API key from the dashboard
  • Basic understanding of REST APIs

Step 1: Get Your API Key

  1. Log in to your Veedeo Dashboard
  2. Navigate to Settings > API Keys
  3. Create a new API key or copy an existing one
  4. Your API key format: vd_[32-character-string]

Step 2: Make Your First Request

Here's a simple example to render a 10-second video with an image:

curl -X POST https://api.veedeo.dev/v3/tasks \
  -H "Authorization: Bearer vd_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "timeline": {
      "duration": 10000,
      "tracks": [
        {
          "type": "video",
          "clips": [
            {
              "media_url": "https://example.com/your-image.jpg",
              "start_time": 0,
              "end_time": 10000,
              "properties": {
                "scale": { "x": 1.0, "y": 1.0 },
                "position": { "x": 0, "y": 0 }
              }
            }
          ]
        }
      ]
    },
    "output": {
      "resolution": { "width": 1920, "height": 1080 },
      "format": "mp4"
    },
    "webhook_url": "https://your-app.com/webhook"
  }'

Step 3: Monitor Progress

The API will return a task ID. Use it to check progress:

curl -H "Authorization: Bearer vd_your_api_key_here" \
  https://api.veedeo.dev/v3/tasks/YOUR_TASK_ID

Step 4: Get Your Video

When complete, the response will include download URLs:

{
  "task_id": "tsk_abc123",
  "status": "completed",
  "output": {
    "video_url": "https://storage.veedeo.dev/renders/your-video.mp4",
    "thumbnail_url": "https://storage.veedeo.dev/thumbnails/thumb.jpg"
  }
}

Next Steps

Test Your Setup

Try our interactive API explorer in the dashboard to test requests without writing code.