Overview

Element

Basic Element

View Element

Video

Effect

Request

Prop	Type	Required	Example	Value Range	Description
compositeWidth	number	true	1920	720 - 3840	The width of the composite.
compositeHeight	number	true	1080	720 - 3840	The height of the composite.
fps	number	true	30	15 - 60	The frame rate of the composite.
projectData	object	true	-	-	The project data. Can be exported from the editor.

Note: The compositeWidth and compositeHeight can differ from the width and height specified in projectData. However, the aspect ratio of compositeWidth to compositeHeight must remain consistent with the aspect ratio of projectData.width to projectData.height.

This design allows the same video project to be exported in different resolutions while maintaining the original aspect ratio.

project.json

{
  "compositeWidth": 1920,
  "compositeHeight": 1080,
  "fps": 30,
  "projectData": {
    "type": "",
    "width": 1920,
    "height": 1080,
    "fill": "#000000",
    "view": [
      {
        "id": "8ecf7475-2c6c-47f9-827b-a09c7913f4c0",
        "type": "Image",
        "start": 0,
        "duration": 5,
        "trackIndex": 0,
        "x": -570.0335392757963,
        "y": -170.90659033307685,
        "blendMode": "normal",
        "anchorX": 1302,

Error Codes

Here are the error codes returned by the rendering API:

2001: Parameter error – The request contains invalid or missing parameters.
2002: User not registered – The provided user ID does not exist.
2003: User is not an API member and cannot use rendering services.
2004: Invalid project data – The projectData field is not a valid JSON object.
2005: Render balance not enough – Insufficient balance to proceed with rendering.
2006: Failed to marshal project data – Could not convert project data to JSON.
2007: Failed to upload JSON data – Error occurred while uploading project data.
2008: Failed to marshal render data – Render request payload could not be serialized.
2009: Failed to send render request – Error occurred while sending the request.
2010: Missing duration field – The duration field is required but missing.
2011: Invalid duration field – The duration field is present but not in the correct format.
2012: Render service failed – The rendering service encountered an internal error.

If you encounter an error code not listed, please contact support at [email protected].