FAQ
What do I need before integration?
Sign in, activate a trial package or purchase credits, and create an enabled API key. Complete this site’s required email or phone verification before purchasing.
How do I manage API keys?
Open API keys.Each account supports up to 10 keys. The Secret Key is shown only at creation. You can rename, enable or disable a key. Disable it before deletion; deleted keys cannot be recovered and dependent calls become invalid.
How do I update my profile?
The Platform Account page shows your linked email and verification status as read-only details. Changing a linked email or phone number is currently unavailable. Complete required first-time linking in Platform when prompted.
Why is there no model after submission?
Tasks are asynchronous. Save task_id and query data.state. Read the result URL on success. created, queueing and processing are not completed states. See Service process.
Can I generate in batches?
Yes. The base quota is 50 concurrent tasks.
- Each API call creates one task. Save and query each
task_idseparately. Multiple views are inputs for one model. - Check Console for your account quota. Excess submissions are subject to queue or rate limits. Concurrency and request rate are separate limits.
How do I upload multiple views?
- Provide 2–4 images, including a front view. Each image may be up to 20 MB.
- Upload the available views in front, back, left, right order.
- Mark the included views with
multi_images_bit. The number of1s must match the image count. For example,1010means front and left.
How do I choose models, resolutions and formats?
See Hi3D overview for capability and model lists, then check complete values, defaults, file limits and conditional parameters in the relevant reference. DepthMap Base/Pro are resolutions; the API uses model_type.
Are failed or timed-out tasks charged?
- Deductions and refunds: Credits are deducted on submission, including for queued or processing tasks, and refunded if a task fails. Check task records for the actual deductions and refunds.
- Validation errors: No generation credits are charged if validation fails before task creation.
- Timeouts: The server-side generation timeout is 60 minutes. If a client request times out, query the original
task_idfor its status.
How long are result links valid?
File and preview links are valid for one hour for Image to 3D, Image to Relief, Image to Embroidery, Texturing, Model Splitting, and Multicolor.
If a link expires, query the original task_id for a fresh link.
How do I troubleshoot failures?
Check connectivity, file format and size, credit balance and model parameters. Multi-view input must include a front view. Reduce submission load or retry later when the queue is busy. For specific codes, see Error handling.
How do I reconcile by customer or project?
Use separate API keys per project. Filter task records by key and creation dates, then export all matching rows. Exports retain the model, resolution, task type, PBR and actual credits used.
How do I get support?
For API issues contact apicontact@hi3d.ai.Include the task ID, error code and relevant environment details, never the Secret Key. For higher usage or custom services, contact sales.
How do I integrate embroidery?
- Submit one image (a file or URL), choose either width or length, and specify the color count, stitch density, and output format.
- Query task status or receive an account-level Webhook notification.
- On success, download the DST or TBF file and preview.
How do I query and export tasks in a different time zone?
Select a UTC offset in Console task records. Creation-date boundaries, created / completed timestamps, details and exported files use that selection. UTC+0 is the default and the selection is remembered. Other pages keep their stated UTC+0 display. Stored timestamps and generation duration do not change.
How do I export more than 50,000 task records?
Use the total number of records matching the actual export date range, filters, and time zone. The following recommendations are not record-count limits.
- Up to 50,000 records: Direct CSV download is recommended.
- Over 50,000 records: Bulk export is recommended. Select Bulk export and confirm your verified email. The system uses the filters and time zone selected at submission, generates the complete CSV, and sends it as an email attachment.
You can retry a failed export. Exports do not consume generation credits.
API support: apicontact@hi3d.ai