> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/api/scenes.md).

# Scenes

Manage the 3D scenes in your Mimeeq account. A 3D scene is the stage the 3D configurator shows a product on: the environment texture that lights it and shows in its reflections, the default material for model parts without one of their own, image contrast and brightness, and the 3D editor's setup of background colour, cameras, lights, ground and bounding box.

Scenes belong to your account and products share them; Get 3D Scene lists the products that use a scene. Use this section to keep scenes in step with another system, or to make the same lighting change across many scenes. Products are linked to a scene in the Mimeeq app; this API does not link them.

The environment texture is a file from your media library (see Files), and the default material is one of your 3D materials (`DMAT-<uuid>`).

### What you can do

| Task                     | Reference                                                                   |
| ------------------------ | --------------------------------------------------------------------------- |
| Find available 3D scenes | [List 3D Scenes](https://help.mimeeq.com/api/scenes/list-3d-scenes)         |
| Add a new 3D scene       | [Create 3D Scene](https://help.mimeeq.com/api/scenes/create-3d-scene)       |
| Read one 3D scene        | [Get 3D Scene](https://help.mimeeq.com/api/scenes/get-3d-scene)             |
| Change 3D scene          | [Update 3D Scene](https://help.mimeeq.com/api/scenes/update-3d-scene)       |
| Remove a 3D scene        | [Delete 3D Scene](https://help.mimeeq.com/api/scenes/delete-3d-scene)       |
| Copy 3D scene            | [Duplicate 3D Scene](https://help.mimeeq.com/api/scenes/duplicate-3d-scene) |

### Before you start

Your API key needs `scenes3d:read` to list and read scenes, and `scenes3d:write` to create, update and duplicate them (it also allows reading). Deleting a scene needs `scenes3d:delete`; write access alone does not delete.

### Important behaviour

An update changes only the top-level fields you send, but `configuration` is one value: sending it replaces the stored configuration as a whole. A configuration setting never saved reads as the value the 3D viewer uses, or `null` where the viewer has none, so a configuration read from Get 3D Scene can be changed and sent back as is. Colours are hex.

The environment texture and the default material must be your own; both are checked before anything is written. Every light needs `target` and `intensity`.

New scenes are `INACTIVE` unless you send `status`, and copies are always `INACTIVE`. A deleted scene moves to the trash, where it can be restored in the Mimeeq app; a scene that products still use cannot be deleted.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/api/scenes.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
