API Guide

Get User Configuration

1
2
3
$ curl -i -X GET "https://render-api.helio.exchange/v1/user/config" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

Save the id returned in this call.

Get User Team

Please, replace in the URL USER_ID with your actual user id.

1
2
3
$ curl -i -X GET "https://render-api.helio.exchange/v1/users/{USER_ID}" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN'

In this response, you need to save from list teams, the id of the first element. We’ll refer to is as TEAM_ID.

Create Workspace

This step is needed to upload the input files to your storage. Replace in the request your TEAM_IDand give your workspace a name by replacing my_name:

1
2
3
4
5
$ curl -i -X POST "https://render-api.helio.exchange/v1/workspaces" \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer ACCESS_TOKEN' \
  -H 'Team-Id: TEAM_ID' \
    -d '{ "name": "my_name" }'

Please save the storageId and workspaceId, they are needed in the following steps.

Get Credentials

In this steps you’ll request the credentials to your storage, you’ll need to replace storageId with the proper value from the previous step.

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": "ReadWrite", "type": "rclone"}''

Upload Project Files

You can use tools like https://rclone.org/ to do synchronise input files to your storage.

1
2
3
4
RCLONE_CONFIG_ENDPOINT=REMOTE:00000000-0000-0000-0000-000000000000 \
RCLONE_CONFIG_REMOTE_SAS_URL="https://renderwesteuropeprod.blob.core.windows.net/..." \
RCLONE_CONFIG_REMOTE_TYPE=azureblob \
rclone sync C:/my_project ${RCLONE_CONFIG_ENDPOINT}

Once the sync is done, you can continue with the next step.