POST Request AI image-rendering for this viewer
POST /viewers/{viewerToken}/ai-renderings: Request AI image-rendering for this viewer. Submit a clipped scene image together with optional AI parameters. The
Are you an LLM? You can read better optimized documentation at /docs/api/endpoints/renderings/post-viewers-viewerToken-ai-renderings.md for this page in Markdown format
POST
Try it out https://api.rooom.com/viewers/{viewerToken}/ai-renderingsScopes
renderings:writeParameters
Path Parameters
| Name | Type | Description |
|---|---|---|
viewerTokenrequiredExample: _viewerToken_ | string | Viewer token. |
Body required
multipart/form-data| Name | Type | Description | Values |
|---|---|---|---|
imagerequired | string | Clipped scene image (jpg|png, max 50MB) | |
background_type | string | Background type for the generated image | transparentwhitescenecustom |
scene_template | string | Scene template key (used when background_type = scene). | living-roomofficeoutdoorstudiokitchenbathroomshowroomminimalistgarden |
custom_scene | string | Custom scene description (used when background_type = custom) | |
additional_instructions | string | Additional instructions forwarded to the AI service | |
resolution | string | Output resolution, key from renderings.defaultformats (longer edge 1024/2048/3840 px). Omitted: service default (1K). | 1K2K4K |
Responses
200Success
400Bad Request (IMAGE_MISSING, FILE_NOT_ACCEPTED, invalid background_type/scene_template/resolution)
401Unauthorized
POST /viewers/{viewerToken}/ai-renderings Request AI image-rendering for this viewer Submit a clipped scene image together with optional AI parameters. The rendering is processed asynchronously. Required scopes: renderings:write viewerToken Viewer token. image Clipped scene image (jpg|png, max 50MB) background_type Background type for the generated image scene_template Scene template key (used when background_type = scene). custom_scene Custom scene description (used when background_type = custom) additional_instructions Additional instructions forwarded to the AI service resolution Output resolution, key from renderings.defaultformats (longer edge 1024/2048/3840 px). Omitted: service default (1K).