# IMVU Room Scripting API

**Canonical:** https://apis.io/apis/imvu/imvu-room-scripting-api/  
**Provider:** Together Labs — https://apis.io/providers/imvu/  
**Documentation:** https://github.com/imvu/imvu-scripting-docs

IMVU Room Scripting API is one of 2 APIs that [Together Labs](https://apis.io/providers/imvu/) publishes on the [APIs.io](https://apis.io/) network. Tagged areas include Scripting, Lua, Virtual Worlds, and Events. The published artifact set on APIs.io includes API documentation, a support channel, and rate-limit docs.

First-party in-world scripting API for IMVU Live Rooms. Room scripts are single-file Lua programs executed server-side in a Luau sandbox; the engine calls event functions (event_start, event_begin_iteration, event_message_received, event_state_changed, event_tip_received, event_end_iteration, event_stop) roughly 20 times a second, and scripts call back into an imvu.* method surface to chat, whisper, place and remove furniture, move and remove scene members, send room invites, control embedded YouTube media, create polls and read audience or scene membership. A data.save / data.load module provides persistent key/value storage scoped to script, room, account or individual visitor. Published as a VIP-only alpha; documentation and nine worked example scripts are published by IMVU on GitHub.

## Machine-readable artifacts (9)

- **Documentation** — https://github.com/imvu/imvu-scripting-docs/blob/main/README.md
- **Examples** — https://github.com/imvu/imvu-scripting-docs/tree/main/scripts
- **SourceCode** — https://github.com/imvu/imvu-scripting-docs
- **Support** — https://github.com/imvu/imvu-scripting-docs/issues
- **RateLimits** — https://raw.githubusercontent.com/api-evangelist/imvu/refs/heads/main/rate-limits/imvu-rate-limits.yml
- **Conventions** — https://raw.githubusercontent.com/api-evangelist/imvu/refs/heads/main/conventions/imvu-conventions.yml
- **Idempotency** — https://raw.githubusercontent.com/api-evangelist/imvu/refs/heads/main/conventions/imvu-conventions.yml
- **DataModel** — https://raw.githubusercontent.com/api-evangelist/imvu/refs/heads/main/data-model/imvu-data-model.yml
- **APIsJSON** — https://raw.githubusercontent.com/api-evangelist/imvu/refs/heads/main/apis.yml

## Other Together Labs APIs (1)

- [IMVU REST API](https://apis.io/apis/imvu/imvu-rest-api/)

## Tags

Scripting, Lua, Virtual Worlds, Events

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/imvu/imvu-room-scripting-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/imvu/.