Documentation
View Markdown

Getting Started

Fastest path to a valid v2 document and first playable example

Getting Started

1. Minimal structure

Start from this shape:

{
  "meta": {
    "version": "2.0.0",
    "width": 1920,
    "height": 1080,
    "fps": 30,
    "background": "#0b1020"
  },
  "tracks": [
    {
      "id": "main",
      "clips": []
    }
  ]
}

Required:

  • meta.version
  • meta.width
  • meta.height
  • meta.fps
  • tracks

2. Add your first visible clip

{
  "type": "text",
  "start": 0,
  "duration": 3,
  "text": "Hello, world",
  "transform": {
    "x": "50%",
    "y": "50%"
  },
  "style": {
    "fontSize": 72,
    "fontWeight": 700,
    "fill": "#ffffff",
    "textAlign": "center"
  }
}

Insert that clip into tracks[0].clips.

3. Full first example

{
  "meta": {
    "version": "2.0.0",
    "title": "My First Video",
    "width": 1920,
    "height": 1080,
    "fps": 30,
    "background": "#0b1020"
  },
  "tracks": [
    {
      "id": "main",
      "clips": [
        {
          "type": "text",
          "start": 0,
          "duration": 3,
          "text": "Hello, world",
          "transform": {
            "x": "50%",
            "y": "50%"
          },
          "style": {
            "fontSize": 72,
            "fontWeight": 700,
            "fill": "#ffffff",
            "textAlign": "center"
          },
          "animations": [
            {
              "type": "fadeIn",
              "duration": 0.5
            }
          ]
        }
      ]
    }
  ]
}

4. Open your first playable preview

Save the full JSON example above as first-video.json. In a terminal with curl installed, run:

curl --fail-with-body https://video.renderingvideo.com/api/preview \
  --header 'Content-Type: application/json' \
  --data-binary @first-video.json

The response contains a relative url, such as /t/…. Open https://video.renderingvideo.com followed by that value in your browser. This public preview needs no account or API key. Its temporary link expires as indicated by expiresIn in the response (normally 7 days).

This preview does not generate a downloadable MP4. To keep editing this JSON in your browser, paste it into the playground. To export an MP4, use your own API key with the authenticated API. Rendering uses account credits; check pricing before submitting a render.

5. What to do next