Hyper3DHyper3D Docs
API Specification

Download Results

Get signed download URLs after all jobs are complete.

POST
/api/v2/download

Authorization

bearer
headerAuthorizationBearer <token>

Request Body

application/json
  1. body
task_uuid*string
Formatuuid

Response Body

application/json
  1. response
error?string
Value in"NO_SUCH_TASK""INVALID_REQUEST"
list?array<>

The list of the model files available for download.

Example Request
curl -X POST 'https://api.hyper3d.com/api/v2/download' \  -H 'Content-Type: application/json' \  -d '{  "task_uuid": "123e4567-e89b-12d3-a456-426614174000"}'
Example Response
{  "error": "NO_SUCH_TASK",  "list": [    {      "url": "string",      "name": "string"    }  ]}

Identifier

Send the generation response's top-level uuid as task_uuid. This differs from the jobs.subscription_key used by Check Status.

Examples Input

curl --fail-with-body --request POST 'https://api.hyper3d.com/api/v2/download' \
  --header "Authorization: Bearer ${RODIN_API_KEY}" \
  --header 'Content-Type: application/json' \
  --data '{"task_uuid":"123e4567-e89b-12d3-a456-426614174000"}'

Response

{
  "list": [
    {
      "name": "model.glb",
      "url": "https://example.invalid/download/model.glb"
    }
  ]
}

Availability and errors

Call this endpoint only after every job is Done; the endpoint does not promise to reject an incomplete task. HTTP 201 returns the files currently available, 400 indicates an invalid request, 401 indicates invalid authentication, and 429 indicates throttling. Download URLs can expire, so fetch files promptly rather than storing the URLs.