We provide a simple Python-based API for using our cloud rendering service. This is the official API that is maintained by Fox Render Farm / Renderbus RD team. The API has been tested ok with python2.7.10 and requests 2.11.1

The latest version can always be found at https://github.com/renderbus/python-api

• requests (We already test ok with requests 2.11.1)

• You must have a Fox Render Farm / Renderbus account to use our service, then create a project and select the plugins you want to use on our web site before submiting.

• Login in our cloud server account first, some information such as access key, you need ask for our support team.

fox = Fox(render_server="www5.renderbus.com", account="XXX", access_key="XXX", aspera_server="app5.renderbus.com", aspera_password="XXX")

• Upload local files or folders to cloud server and skip the existing same file by default.

fox.upload(path_list=[r"v:\project\shot\lgt.ma", r"v:\project\asset\sourceimages"])

• After all the dependancy files of Maya Task such as texture, cache etc have been uploaded, you can submit task to cloud server.

fox.submit_task(project_name="XXX", input_scene_path=r"v:\project\shot\lgt.ma", frames="1-10[1]")

• You can also try below mnethod to add some extra info to submit the task.

task_info = {"project_name": "api",
               "input_scene_path": r"E:\test_files\2014_api_camera_layer.mb",
               "frames": "1073-1073[1]",
               "render_layer": "ball",
               "camera": "camera1"}
fox.submit_task(**task_info)

• After rendering complete, you can download the entire task output files from cloud server, but single frame download function is not supported yet. The download method will skip the existing same files which already downloaded by default.

fox.download(task_id=11111, local_path=r"v:\project\output")

• get user info

fox.get_users()

• get all projects

fox.get_projects()

• get specific project info

fox.get_projects(project_name="XXX")

• get all tasks

fox.get_tasks()

• get task using task filter

task_filter={"project_name": "XXX", "task_status": "Start"}
task_filter={"project_name": "XXX", "task_status": "System_Done"}
fox.get_tasks(task_filter=task_filter)

• get all tasks of specific project

fox.get_tasks(project_name="XXX")

• get specific task

fox.get_tasks(task_id=11111)

• get specific task with frames info

fox.get_tasks(task_id=11111, has_frames=1)

Generally, This is not necessary to see this manual, but if you like you can find the latest version HTTP API Manual at https://innerx.gitbooks.io/rayvision-render-api/content/, we only have a chinese version of manual currently.