API reference

Base URL

https://api.reactvideoeditor.com

Authentication

Send your Cloud Rendering API key as a bearer token from your server.

Authorization: Bearer YOUR_API_KEY

Never send this key to the browser.

Start a render

POST /renders/render
Content-Type: application/json
Idempotency-Key: UNIQUE_REQUEST_ID

The request body uses the RVE VideoRenderer contract. It includes the composition identifier and inputProps generated by the SDK. Forward this body through your server without adding the API key to browser code.

The response includes the render identifier needed for progress checks. Store it with your own job record.

Use one stable Idempotency-Key for each logical output. If a network request fails before you receive a response, retry with the same key. Use a new key when you intend to create a new output.

Get progress

POST /renders/progress
Content-Type: application/json

Send the render identifier returned by the start request. Continue to poll until the response is done or error.

The progress response uses one of these renderer states:

{
  "type": "progress",
  "progress": 0.45
}

{
  "type": "done",
  "url": "https://example.com/output.mp4",
  "size": 12345678
}

{
  "type": "error",
  "message": "The render could not be completed."
}

Treat done and error as final states. A progress value of 1 does not replace the final done response because the service can still be storing the output.

Source information

Your integration can include a short application name and an external reference. These values help you identify renders in the RVE Portal. Do not send personal data in these fields.

Server proxy requirements

• Authenticate the user before you forward a request.
• Keep the RVE API key in a server environment variable.
• Validate that the request belongs to the correct customer account.
• Do not log API keys, signed media URLs, or complete render payloads.
• Apply your own user and batch limits before you call the RVE API.

Errors

The API returns a JSON error message with a non-success HTTP status. Log the request reference and the message on your server. Do not log the API key or private signed media URLs.

Do not retry validation or authentication errors without a change. For an uncertain network failure, retry the same logical render with the same idempotency key.