# Hyper3D API

> Provider: **Hyper3D**
> Source: https://www.pixazo.ai/models/hyper3d

3D generation capabilities.

## Hyper3D Rodin v1

### Image to Image (3D Models — Text & Image to 3D)

## Base URL

```
https://gateway.pixazo.ai/hyper3d-rodin-259/v1
```

## Authentication

All requests require an API key passed via header.

Header

Type

Required

Description

Ocp-Apim-Subscription-Key

string

Yes

Your API subscription key

## Hyper3D Rodin generate request - Hyper3D Rodin

## Request Code

HTTP Python JavaScript cURL

```
POST https://gateway.pixazo.ai/hyper3d-rodin-259/v1/hyper3d-rodin-request
Content-Type: application/json
Cache-Control: no-cache
Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY
{
  "prompt": "A futuristic robot with sleek metallic design and glowing blue accents",
  "input_image_urls": [
    "https://pub-5e7dd3f6986243de990b46ce581cf66e.r2.dev/v1/hyper3d-rodin-259_019dde5c-1240-78d7-9df5-2b73b4629b522/input_0.png"
  ],
  "condition_mode": "concat",
  "geometry_file_format": "glb",
  "material": "Shaded",
  "quality": "medium",
  "tier": "Regular"
}
```

```
import requests

url = "https://gateway.pixazo.ai/hyper3d-rodin-259/v1/hyper3d-rodin-request"
headers = {
    "Content-Type": "application/json",
    "Cache-Control": "no-cache",
    "Ocp-Apim-Subscription-Key": "YOUR_SUBSCRIPTION_KEY"
}
data = {
  "prompt": "A futuristic robot with sleek metallic design and glowing blue accents",
  "input_image_urls": [
    "https://pub-5e7dd3f6986243de990b46ce581cf66e.r2.dev/v1/hyper3d-rodin-259_019dde5c-1240-78d7-9df5-2b73b4629b522/input_0.png"
  ],
  "condition_mode": "concat",
  "geometry_file_format": "glb",
  "material": "Shaded",
  "quality": "medium",
  "tier": "Regular"
}

response = requests.post(url, json=data, headers=headers)
print(response.json())
```

```
const url = 'https://gateway.pixazo.ai/hyper3d-rodin-259/v1/hyper3d-rodin-request';

const data = {
  "prompt": "A futuristic robot with sleek metallic design and glowing blue accents",
  "input_image_urls": [
    "https://pub-5e7dd3f6986243de990b46ce581cf66e.r2.dev/v1/hyper3d-rodin-259_019dde5c-1240-78d7-9df5-2b73b4629b522/input_0.png"
  ],
  "condition_mode": "concat",
  "geometry_file_format": "glb",
  "material": "Shaded",
  "quality": "medium",
  "tier": "Regular"
};

fetch(url, {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Cache-Control': 'no-cache',
    'Ocp-Apim-Subscription-Key': 'YOUR_SUBSCRIPTION_KEY'
  },
  body: JSON.stringify(data)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));
```

```
curl -X POST "https://gateway.pixazo.ai/hyper3d-rodin-259/v1/hyper3d-rodin-request" \
  -H "Content-Type: application/json" \
  -H "Cache-Control: no-cache" \
  -H "Ocp-Apim-Subscription-Key: YOUR_SUBSCRIPTION_KEY" \
  --data-raw '{
  "prompt": "A futuristic robot with sleek metallic design and glowing blue accents",
  "input_image_urls": [
    "https://pub-5e7dd3f6986243de990b46ce581cf66e.r2.dev/v1/hyper3d-rodin-259_019dde5c-1240-78d7-9df5-2b73b4629b522/input_0.png"
  ],
  "condition_mode": "concat",
  "geometry_file_format": "glb",
  "material": "Shaded",
  "quality": "medium",
  "tier": "Regular"
}'
```

## Output

```
{
  "request_id": "hyper3d-rodin-259_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/hyper3d-rodin-259_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

[Try Now](https://api.pixazo.ai/api-details#api=hyper3d-rodin-259-api&operation=hyper3d-rodin-request)

## Webhook (Optional)

Add the `X-Webhook-URL` header to your generate request to receive a POST callback instead of polling.

```
X-Webhook-URL: https://your-server.com/webhook/callback
```

## Request Parameters - Hyper3D Rodin generate request

Parameter

Required

Type

Description

prompt

Yes

string

A detailed textual description of the desired 3D object or scene. Be specific about shape, texture, color, and context.

input\_image\_urls

No

string

URL to a single input image used as a reference for 3D generation. Supported formats: PNG, JPG, JPEG.

condition\_mode

No

string

Determines how the input image is used in generation. "concat" combines image features with text prompt. Other modes may be supported in future.

geometry\_file\_format

No

string

Output format for the generated 3D geometry. Supported values: "glb", "gltf", "obj".

material

No

string

Style of material rendering. Options: "Shaded", "Wireframe", "Flat".

quality

No

string

Level of detail and rendering quality. Values: "low", "medium", "high", "ultra".

tier

No

string

Processing priority tier. "Regular" is standard; "Premium" may be available for paid plans.

## Example Request

```
{
  "prompt": "A futuristic robot with sleek metallic design and glowing blue accents",
  "input_image_urls": [
    "https://pub-5e7dd3f6986243de990b46ce581cf66e.r2.dev/v1/hyper3d-rodin-259_019dde5c-1240-78d7-9df5-2b73b4629b522/input_0.png"
  ],
  "condition_mode": "concat",
  "geometry_file_format": "glb",
  "material": "Shaded",
  "quality": "medium",
  "tier": "Regular"
}
```

## Response

```
{
  "request_id": "hyper3d-rodin-259_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "QUEUED",
  "polling_url": "https://gateway.pixazo.ai/v2/requests/status/hyper3d-rodin-259_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}
```

## Request Headers

Header

Value

Content-Type

application/json

Cache-Control

no-cache

Ocp-Apim-Subscription-Key

YOUR\_SUBSCRIPTION\_KEY

## Response Handling

Common status codes.

Code

Meaning

202

Accepted — Request queued

400

Bad Request

401

Unauthorized

402

Insufficient Balance

403

Forbidden

429

Too Many Requests

500

Internal Server Error

## Error Responses

Queue system errors and model validation errors.

### Queue System Errors

```
// 402 — Insufficient balance
{
  "error": "Insufficient Balance",
  "message": "Your wallet does not have enough balance."
}
```

```
// 400 — Model not found
{
  "error": "Model not found",
  "message": "Model 'hyper3d-rodin-259' not found or is disabled"
}
```

### Error via Status/Webhook

```
{
  "request_id": "hyper3d-rodin-259_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "ERROR",
  "model_id": "hyper3d-rodin-259",
  "error": "Description of the error",
  "output": null
}
```

## Retrieving Results

Poll the universal status endpoint to check progress and retrieve results.

### Endpoint

```
GET https://gateway.pixazo.ai/v2/requests/status/{request_id}
Ocp-Apim-Subscription-Key: YOUR_API_KEY
```

## cURL Example

```
curl -H "Ocp-Apim-Subscription-Key: YOUR_API_KEY" \
  "https://gateway.pixazo.ai/v2/requests/status/hyper3d-rodin-259_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
```

## Response (Completed)

```
{
  "request_id": "hyper3d-rodin-259_019dxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
  "status": "COMPLETED",
  "model_id": "hyper3d-rodin-259",
  "error": null,
  "output": {
    "media_url": [
      "https://pub-582b7213209642b9b995c96c95a30381.r2.dev/v1/hyper3d-rodin-259_019dxxxx-xxxx/output.ext"
    ],
    "media_type": "application/octet-stream"
  },
  "created_at": "2026-03-31T10:00:00.000Z",
  "updated_at": "2026-03-31T10:00:15.000Z",
  "completed_at": "2026-03-31T10:00:15.000Z"
}
```

## Response Fields

Field

Type

Description

request\_id

string

Unique request identifier

status

string

QUEUED, PROCESSING, COMPLETED, FAILED, or ERROR

model\_id

string

Model that processed the request

error

string|null

Error message if failed

output.media\_url

array

URLs to generated media (R2 CDN)

output.media\_type

string

MIME type of the output

created\_at

string

When request was created

completed\_at

string|null

When request completed

polling\_url

string

Status URL (initial response only)

## Status Values

Status

Description

QUEUED

Request accepted, waiting to be processed

PROCESSING

Being processed by the model

COMPLETED

Done — output contains the result

FAILED

Failed — check error field

ERROR

System error — not charged

## Status Flow

```
QUEUED → PROCESSING → COMPLETED
                    → FAILED
                    → ERROR
```

## Typical Workflow

1.  **Send a generate request** to the API endpoint
2.  **Save the `request_id`** from the response
3.  **Poll** every 5-10 seconds: `GET /v2/requests/status/{request_id}`
4.  **When `status` is `"COMPLETED"`**, download from `output.media_url`

**Tip:** Use `X-Webhook-URL` header to get a callback instead of polling.