APIs

The kit comes with API routes to render remotion videos, fetch progress, and callback webhooks.

Render API

The render API is used to render the video. It is a POST request that takes the composition name and the input props.

POST /api/remotion/render

This is a protected route by default. You need to pass the Authorization header with the value Bearer <token>.

• props - The input props for the composition.
• composition - The composition name.
• codec - The codec to use for the video.
• projectId - The project ID.

Progress API

The progress API is used to fetch the progress of the render. It is a GET request that takes the render ID.

GET /api/remotion/render/{id}

It is a protected route by default.

Webhook API

The webhook API is used to listen to the webhook callbacks from the render lambda fuction. It already handles most of the scenarios. It does following things:

• Update the status of the render in the database
• Cosume the credit for the user