Guides
Rendering
POST /v1/renders turns a draft image (a 3D software export, a raw render) into a photorealistic image, at the same framing.curl https://api.renderthink.com/v1/renders \-H "Authorization: Bearer $RENDERTHINK_API_KEY" \-H "Content-Type: application/json" \-d '{"image": "https://developers.renderthink.com/assets/scenes/sejour-charpente-export.webp", "quality": "2k"}'
| Name | Type | Description |
|---|---|---|
image | string | Required. https:// URL or file in multipart/form-data (see Images). |
quality | string | Required. Output resolution: 1k, 2k, 4k or 8k (see Resolutions). |
metadata | object | Free-form key-value pairs attached to the generation and returned with it (see Metadata). |
background | boolean | true: immediate response, result by webhook or by reading it (see Generations). |
Key permission:
renders.The ended generation, of type
render (200); with background: true, the generation in progress (202). The output image is in output[0].url.| Status | Code | Cause |
|---|---|---|
| 400 | parameter_invalid | quality missing or unknown, or metadata out of bounds. |
| 503 | mode_unavailable | Rendering temporarily unavailable. |
Errors shared by every route (key, balance, images, limits) are in Errors.