API Guide

Start Rendering

Before starting a render, please have a look at the render settings, so you can see all available options you can send in the request: Render APIAutomated renderings without limits. Integrated into your pipeline with every programming language.

Don’t forget to replace TEAM_ID, workspace_id and projectName.

1
2
3
4
5
curl -i -X POST "https://render-api.helio.exchange/v1/renders" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Team-Id: {team_id}' \
  -d '{"projectName": "project_name", "file": "file_name", "workspaceId": "workspace_id"}'

As a recommendation, for every project you'd like to render, send a preview with a higher noise limit and less frames to ensure the rendering works correctly.

Please ensure all textures are in the uploaded project folder.

Check Rendering Status

There are two ways to check a specific render:

• One requires you to provide its id (you’ll receive it when starting a render):

1
2
curl -i -X GET "https://render-api.helio.exchange/v1/renders/RENDER_NAME" \
  -H 'Authorization: Bearer ACCESS_TOKEN'

• Or you can just list your the renders:

1
2
curl -i -X GET "https://render-api.helio.exchange/v1/renders" \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Download Results

Once your render has successfully finished, you can download the results from your storage.

Request the information of your render’s storage output

1
2
curl -i -X GET "https://render-api.helio.exchange/v1/renders/RENDER_NAME" \
  -H 'Authorization: Bearer ACCESS_TOKEN'

User the value in outputStorageId to get the credentials to your output storage.

1
2
3
4
$ curl -i -X POST "https://render-api.helio.exchange/v1/storage/{storageId}/credential" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
    -d '{"accessMode": "ReadOnly", "type": "rclone"}'

Now you can copy the content to your local folder by:

1
2
3
4
RCLONE_CONFIG_ENDPOINT=REMOTE:00000000-0000-0000-0000-000000000000 \
RCLONE_CONFIG_REMOTE_SAS_URL="https:..." \
RCLONE_CONFIG_REMOTE_TYPE=azureblob \
rclone copy $RCLONE_CONFIG_ENDPOINT C:/my_project_output_folder