Download Results

Download result for a given task submitted to the API.

Download ResultsCall this API endpoint to get the download URLs for your generation task following a Done status returned by the Check Status endpoint.Calling this API endpoint before the task is done may return unexpected results like imcomplete list of files. See Check Status for how to see if a task has finished.### Pricing

We do not charge any addtional credits for calling this API to download results of your task.

Request

Authentication

This API uses bearer key for authentication. You need to include a valid token in the Authorization header for all requests.

Authorization: Bearer RODIN_API_KEY

Body

The API takes one parameter in the POST request body.

Use the uuid field instead of jobs.uuids for task_uuid in the response from the Generation API.

| Parameter | Type | Description | | -------------- | ---------- | -------------------------------------------------------------------------------------------------------------------------------------- | | task_uuid | string | Required. The UUID of the task you want to query the status of. Typically you will get it in the response from the Generation API. |

Response

The JSON response has the following fields. You can download preview.webp in the list to preview the model.

Property	Type	Description
error	string	Optional. Error message, if any.
list	array	The list of the model files available for download for this task.
list.url	string	The URL to download the model files from.
list.name	string	A human-readable name for the model file.

Examples```sh

export RODIN_API_KEY="your api key" curl -X 'POST' 'https://api.hyper3d.com/api/v2/download' -H 'accept: application/json' -H 'Content-Type: application/json' -d '{ "task_uuid": "your-task-uuid" }' unset RODIN_API_KEY </div><div data-gb-custom-block data-tag="tab" data-title='Request with Python3'>python import requests

Constants

ENDPOINT = "https://api.hyper3d.com/api/v2/download" API_KEY = os.getenv("HYPER3D_API_KEY") TASK_UUID = "your-task-uuid" # Replace with your actual task UUID

Prepare the headers

headers = { 'accept': 'application/json', 'Content-Type': 'application/json', 'Authorization': f'Bearer {API_KEY}', }

Prepare the JSON payload

data = { "task_uuid": TASK_UUID }

Make the POST request

response = requests.post(ENDPOINT, headers=headers, json=data)

Parse and return the JSON response

print(response.json())

</div><div data-gb-custom-block data-tag="tab" data-title='Response'>json { "list": [ { "url": "https://example.com/", "name": "testfile" } ] }