Quickstart

Let's get started using the Editframe Video Development Platform. We'll cover how to make your first API request and how to create your first video.

To get started, create a new application in the developer portal, or use an existing one.

Making your first API request

After identifying your API token as covered in the authentication guide, you are ready to make your first call to the Editframe API. Here's a sample GET request to the Videos endpoint to get a list of all your videos.

curl -G https://api.editframe.com/v2/videos \
  -H "Authorization: Bearer { API_TOKEN }" 

Creating your first video

import { Editframe } from "@editframe/editframe-js"

const editframe = new Editframe({ token: "API_TOKEN" })

const composition = await editframe.videos.new(
  {
    backgroundColor: "#c400ac",
    dimensions: {
      height: 1080,
      width: 1920,
    },
    duration: 10,
    metadata: {
      user_id: 1
    },
  },
);

await composition.addVideo("https://editframe.com/docs/composition/create-composition/puppy-beach.mp4")

await composition.encode();

What's next?

Great, you're now set up with an API client and have made your first request to the API. Here are a few links that might be handy as you venture further into the Protocol API:

• Learn how to use webhooks to listen to video events
• Create a more dynamic video using transitions