🖥️API Reference
The M² REST API is a REST-styled API that gives full control over the M² platform.
Developers can use the M² REST API to interact programmatically with M² resources and services using HTTP requests.
With the API, developers can create game content and mods, list user / server data, manage pixel streaming sessions, retrieve information about their organization and projects.
M² REST API supports any programming language or framework that can send HTTP requests. Our API reference shows examples written using Python, cURL and JavaScript.
Basics
Spec
Our API is exposed as an HTTP/2 endpoint over TLS. All endpoints live under a dedicated customer URL (https://{organization-id}.m2worlds.io) and follow REST practices.
Rate Limits
We limit the number of calls you can make over a certain period of time. When the rate limit is exceeded, an error is returned with the status 429 Too Many Requests. Calling applications will need to handle the 429 status code and use exponential backoff or some other retry logic to decrease the rate of calls to your API.
Endpoints
A service that provides features for the management of accounts
Manages ownership of virtual objects in a user's collection
Manages events
Manages arbitrary data persisted for game clients and game servers
Manages organizations, projects and launch contexts
Manages WebSocket connections to the platform
Provides session management functions for both streaming and native clients, including World queuing and travel.
Manages user profiles
Manages World Builder content and mods
Manages worlds configuration and lifecycle
Next Steps
Integrate your Web app with M² Frontend SDKs
Explore our Features & Tutorials
Last updated