API
Authenticate with Authorization: Bearer YOUR_API_KEY (create a key in the dashboard). Submit the job, then poll until status is completed or failed.
POST /v1/image-to-3d
Accepts multipart/form-data with an image file, or form/JSON with image_url or image_base64.
| Field | Type | Required | Description |
|---|
image | file | one of | Input image (JPG/PNG/WebP, max 10 MB, shortest side ≥ 256 px). |
image_url | string | one of | Public http/https URL of the input image (form or JSON). |
image_base64 | string | one of | Base64-encoded image (form or JSON). |
prompt | string | no | Optional hint about the object, max 400 characters; must not contain --. |
format | string | no | glb (default) | obj | fbx | usdz | stl |
material | string | no | PBR (default) | Shaded | All | None |
Response: generation_id, status: "processing", credits_used, format, estimated_seconds (180) and poll_url. Poll GET /v1/image-to-3d/{generation_id}: status is processing, completed (then output_url is the 3D file) or failed (with error_message; credits refunded).
cURL
curl -X POST https://api.pixelapi.dev/v1/image-to-3d \
-H "Authorization: Bearer YOUR_API_KEY" \
-F "image=@bag.jpg" \
-F "format=glb" \
-F "material=PBR"
# then poll every 15-30 s until status is "completed" (or "failed")
curl https://api.pixelapi.dev/v1/image-to-3d/GENERATION_ID -H "Authorization: Bearer YOUR_API_KEY"
Python
import time, requests
API = "https://api.pixelapi.dev"
HEADERS = {"Authorization": "Bearer YOUR_API_KEY"}
with open("bag.jpg", "rb") as f:
job = requests.post(f"{API}/v1/image-to-3d", headers=HEADERS,
files={"image": f},
data={"format": "glb", "material": "PBR"}).json()
gen_id = job["generation_id"]
while True:
time.sleep(20)
r = requests.get(f"{API}/v1/image-to-3d/{gen_id}", headers=HEADERS).json()
if r["status"] == "completed":
with open("bag.glb", "wb") as out:
out.write(requests.get(r["output_url"]).content)
break
if r["status"] == "failed":
raise RuntimeError(r.get("error_message")) # credits are refunded
Requires a paid plan (Starter and up); free-trial accounts receive an error and are not charged. At most 2 models can be in progress per account.
