Hydrilla
Get API Key

Quickstart Guide

Get up and running with the Hydrilla AI API in 3 simple steps: authenticate, submit a 3D reconstruction task, and poll for the downloadable GLB mesh.

Before you start

You need an API key that starts with hyd_live_. Create one in the Authentication guide if you don't have one yet.

Create your API key

API requests require a key that starts with hyd_live_.

  1. Log in to the Hydrilla Studio.
  2. Open API Keys in your dashboard sidebar.
  3. Click Create Secret Key, give it a name (for example, Production-Backend), and copy the revealed API key.

Trigger 3D reconstruction

Submit a prompt to the POST /v1/3d/text-to-3d endpoint. Hydrilla compiles the prompt, renders concept views, and dispatches the job to the BlueFox GPU cluster.

bashrequest.sh
curl -X POST https://backend.hydrilla.ai/v1/3d/text-to-3d \
  -H "Authorization: Bearer hyd_live_your_api_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "prompt": "Futuristic cyberpunk vehicle, high details, game ready prop",
    "image_model": {
      "provider": "openai",
      "quality": "high"
    },
    "resolution": 1536
  }'

The endpoint returns an asynchronous task ID:

json200_SUCCESS.json
{
  "id": "job_c18ab44d03e192a40",
  "status": "queued",
  "resolution": 1536,
  "links": {
    "poll": "https://backend.hydrilla.ai/v1/3d/tasks/job_c18ab44d03e192a40"
  }
}

Poll for completion and download the mesh

Poll GET /v1/3d/tasks/:taskId every 2–3 seconds until the status reaches SUCCEEDED. Generation usually takes a few minutes.

bashrequest.sh
curl -X GET https://backend.hydrilla.ai/v1/3d/tasks/job_c18ab44d03e192a40 \
  -H "Authorization: Bearer hyd_live_your_api_key_here"
json200_SUCCESS.json
{
  "id": "job_c18ab44d03e192a40",
  "status": "SUCCEEDED",
  "progress": 100,
  "result": {
    "mesh_url": "https://storage.googleapis.com/hydrilla-meshes/job_c18ab.glb",
    "preview_image_url": "https://storage.googleapis.com/hydrilla-meshes/job_c18ab_thumb.png",
    "format": "glb",
    "triangles": 128450
  }
}

Complete Python example

Run this self-contained script to test end-to-end 3D generation:

pythonquickstart.py
import requests
import time

API_KEY = "hyd_live_your_api_key_here"
HEADERS = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json"
}

# 1. Trigger Text-to-3D
res = requests.post("https://backend.hydrilla.ai/v1/3d/text-to-3d", headers=HEADERS, json={
    "prompt": "Futuristic cyberpunk vehicle, high details, game ready prop",
    "resolution": 1536
})
task_id = res.json()["id"]
print(f"Task submitted: {task_id}")

# 2. Poll until complete
while True:
    task = requests.get(f"https://backend.hydrilla.ai/v1/3d/tasks/{task_id}", headers=HEADERS).json()
    status = task.get("status")
    print(f"Status: {status} ({task.get('progress', 0)}%)")
    
    if status == "SUCCEEDED":
        glb_url = task["result"]["mesh_url"]
        print(f"3D Model Ready! Download at: {glb_url}")
        break
    elif status in ("FAILED", "CANCELLED"):
        print("Failed:", task.get("error"))
        break
        
    time.sleep(3)

Next steps

Was this page helpful?