API Guide
Start Rendering
Before starting a render, please have a look at the render settings, so you can see all available options you have.
1 2 3 4
curl -i -X POST "https://render-api.helio.exchange/v1/renders" \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer ACCESS_TOKEN' \ -d '{"projectName": "my_render", "maxFile": "file.max"}'
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_ID" \ -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'