Guides

Decoration

POST /v1/decorations adds accessories on the free surfaces of an already furnished room: wall art, textiles, plants, decorative objects, books, tableware, table lamps and rugs. The decoration adds no furniture.

curl https://api.renderthink.com/v1/decorations \
  -H "Authorization: Bearer $RENDERTHINK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "image": "https://developers.renderthink.com/assets/scenes/sejour-charpente-rendu.webp",
    "quality": "2k",
    "style": "japandi",
    "density": "minimal",
    "categories": ["plants", "books", "tableware"]
  }'

Parameters

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).
`style`	string	`auto` (default), which follows the style of the room, or the `id` of a style.
`density`	string	Amount of accessories: `minimal` (a few touches), `moderate` (default) or `rich` (a richly dressed room).
`color_tone`	string	Color tone: `neutral` (whites, beiges, light woods), `balanced` (default, neutrals lifted by a few colors) or `bold` (strong colors).
`character`	string	Character of the objects: `subtle` (simple objects that blend into the room), `balanced` (default, a few eye-catching pieces) or `bold` (strong objects that assert the style).
`categories`	array	Allowed accessory families: `wall_art`, `textiles`, `plants`, `decorative_objects`, `books`, `tableware`, `table_lamps`, `rugs`. From 1 to 16 values; a repeated value counts once. Default: all.
`metadata`	object	Free-form key-value pairs attached to the generation and returned with it (see Metadata).
`background`	boolean	`true`: the request responds as soon as the generation is accepted, and the result arrives by webhook or by retrieval (see Generations).

Key permission: decorations.

Response

The API returns the ended generation, of type decoration, with the 200 status; with background: true, it returns the generation in progress, with the 202 status. The output image is in output[0].url. The input field returns every setting, defaults included.

Each call decorates a single view. The decoration avoids the accessories of the latest decorations requested: two views of the same room therefore receive different decorations.

Errors

Status	Code	Cause
400	`parameter_invalid`	`quality` missing or unknown, unknown `style`, unknown value of `density`, `color_tone`, `character` or `categories`, `categories` empty or longer than 16 values, or `metadata` out of bounds.
503	`mode_unavailable`	Decoration temporarily unavailable, or unavailable at the requested resolution.

Input image errors are described in Input images, and errors shared by every route (key, permissions, balance, limits) in Errors.