URL Parameters
Configure the rooomAvatars Editor behavior using URL query parameters and hash fragments.
Are you an LLM? You can read better optimized documentation at /docs/rooom-avatars/editor/url-parameters.md for this page in Markdown format
Configure the rooomAvatars Editor by appending query parameters and a hash fragment to the iframe src.
Overview
Query parameters are appended after ? (for example ?transparent&full). The API token is passed in the URL hash fragment (#token=...). The configurator reads the token on load and immediately removes it from the URL to reduce exposure.
Query parameters
| Parameter | Value | Effect |
|---|---|---|
transparent | (flag) | Makes the background transparent. |
full | (flag) | Enables full-screen layout mode. |
name | 0 | Hides the avatar name input field. Any other value (or missing) shows it. |
doneAnimation | 0 | Disables the "done" animation. Any other value (or missing) enables it. |
lng | de, en, fr, es, it, pt, nl | Overrides the UI language. If missing, the browser language is used (fallback: en). |
theme | light / dark | Sets the UI theme. If missing (or an invalid value is provided), the default theme is used. |
config | URL-encoded JSON | Initial avatar settings JSON applied on load (see Configuration Schema). |
avatarName | string | Initial avatar name pre-filled on load. |
Hash fragment
| Fragment | Value | Effect |
|---|---|---|
#token | string | API bearer token used for POST /avatar requests. Required for saving. The token is read on load and then removed from the URL. |
Examples
Build the src URL by appending query parameters to the configurator host and adding the token as a hash fragment:
https://editor.avatars.rooom.com/?transparent#token=YOUR_API_TOKENhttps://editor.avatars.rooom.com/?transparent&full&theme=light&lng=de#token=YOUR_API_TOKENhttps://editor.avatars.rooom.com/?name=0&doneAnimation=0&config=%7B%22body%22%3A%7B%22gender%22%3A%22feminine%22%7D%7D#token=YOUR_API_TOKEN
Replace YOUR_API_TOKEN with the token obtained from the rooomAvatars console.