> 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/3d-templates.md).

# 3D Templates

Manage the global 3D templates in your Mimeeq account. A 3D template is hotspot content: what a shopper sees when they open a hotspot on a 3D product, built from ordered text, document and gallery blocks.

Global templates belong to your account and many products can use the same one; Get 3D Template lists them. Product-level templates, made for a single product in the Mimeeq app, are not part of this API. Use this section to keep hotspot content in step with another system, such as product copy, manuals and media. Hotspots and their templates are attached to products in the Mimeeq app; this API does not attach them.

Documents and gallery images are files from your media library (see Files), and gallery blocks hold the same items as Galleries.

### What you can do

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

### Before you start

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

### Important behaviour

Template names are unique, ignoring case. An update that sends `blocks` replaces the whole block list, and array order is the display order. Block text reads as formatted `{ html, text }` but is written as plain text; a language sent back unchanged keeps its formatting.

Every document and media-library gallery file must be one of your files; they are checked before anything is written.

New templates are `INACTIVE` unless you send `status`, and copies are always `INACTIVE`. A deleted template moves to the trash, where it can be restored in the Mimeeq app; a template 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/3d-templates.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.
