sessions
Manages M2 streaming and native client sessions.
Last updated
Manages M2 streaming and native client sessions.
Last updated
Default Response
Provides information about the service status.
Soft-deletes the specified Session, disconnecting the user from any active experiences they may be partaking in. Any resources used by the user, such as streaming slots, will be automatically recovered.
The ID of the session
Default Response
HTTP error message
Fastify error code
User error message
HTTP status code
Admits a Queued Session, allowing the client to join the respective World.
The ID of the session
Default Response
HTTP error message
Fastify error code
User error message
HTTP status code
Refreshes the session and returns the updated state, using a signed session ID. This is
typically provided as the `keepAlivePath` field in returned Sessions.
This endpoint is intended for use by clients that do not have an access token that may
last the entire length of the session.
Such clients should call this endpoint when the Session is no longer required, to more
promptly clean up used resources for use by other users.
The signed ID of a session for use with unauthenticated keep alive requests.
Default Response
For Launch Context-scoped streaming Sessions, indicates the Session is still in use, preventing it from being automatically expired and terminating the user's experience.
The signed ID of a session for use with unauthenticated keep alive requests.
Default Response
The time the session expires
For Launch Context-scoped streaming Sessions, indicates the Session is still in use, preventing it from being automatically expired and terminating the user's experience.
The signed ID of a session for use with unauthenticated keep alive requests.
Default Response
The time the session expires
Refreshes the given Session - should be called periodically as long as the Session is required.
For new Sessions in the Queued
state, this endpoint should be called periodically (as often as
every 5s) by either the frontend UI or the Unreal client until it reaches the Ready
or Active
state.
Streaming clients will be provided with connection information via the providerConfig
field in the
response, which can be used to connect to the chosen streaming provider.
Native clients must call the /api/worlds/:worldId/connection
endpoint to retrieve deployment info.
If the token
field is populated, it must be used as the bearer token for the request.
Once connected to the World, this endpoint should then continue to be called periodically (at least once every 30s) by the client to indicate that the Session is still in use and should not be expired or the user disconnected.
The returned Session may transition to the Failure
state if an error was encountered during
the refresh process. Alternatively, if the Session was deleted or expired, this will be reflected
in the returned value and the client should react accordingly.
The ID of the session
Default Response
The ID of the session
The state of the session
Config data for the chosen provider
Access token to use to retrieve World server information.
Refreshes the session and returns the updated state, using a signed session ID. This is
typically provided as the `keepAlivePath` field in returned Sessions.
This endpoint is intended for use by clients that do not have an access token that may
last the entire length of the session.
Such clients must call this endpoint every 30s until the Session is no longer required,
at which point clients should call the delete endpoint to clear up the Session's resources.
The signed ID of a session for use with unauthenticated keep alive requests.
Default Response
The ID of the session
The state of the session
Config data for the chosen provider
Access token to use to retrieve World server information.
Fetches and returns the specified Session.
The ID of the session
Default Response
The ID of the session
The ID of a project
The ID of an organization
The ID of a user
The ID of a launch context
The ID of a world
The state of the session
The type of client
The time the session was created
The time the session started streaming
The time the session was last updated
The time the session expires
The ID of the Stream Context being used by this Session
The ID of the streaming slot from the Stream Manager
Config data for the chosen provider
The metadata of a session
Retrieves and returns all world sessions that belong to the given Organization, for administration purposes. Supports filtering the returned Sessions by various criteria.
Default Response
The ID of the session
The ID of a project
The ID of an organization
The ID of a user
The ID of a launch context
The ID of a world
The state of the session
The type of client
The time the session was created
The time the session started streaming
The time the session was last updated
The time the session expires
The ID of the Stream Context being used by this Session
The ID of the streaming slot from the Stream Manager
Config data for the chosen provider
The metadata of a session
Creates a Session for the current user. May return a World-scoped Session if a World ID is supplied and World-scoped Sessions are enabled in the Launch Context - otherwise a Launch Context-scoped Session will be returned.
Any existing Sessions belonging to the user will be invalidated, and they will be disconnected from those Sessions within 30 seconds.
If a World ID is supplied, and there is no capacity available for the requested World, the returned Session will be in the Queued
state and the client must poll the Refresh Session endpoint until they reach the head of the queue.
The ID of a world
The type of client
The time the session started streaming
The time the session was last updated
The time the session expires
The ID of the Stream Context being used by this Session
The ID of the streaming slot from the Stream Manager
Config data for the chosen provider
The metadata of a session
Default Response
The ID of the session
The signed ID of a session for use with unauthenticated keep alive requests.
Config data for the chosen provider
The state of the session