The resource path of the universe.
Format: universes/{universe_id}.
Represents a Roblox experience.
The resource path of the universe.
Format: universes/{universe_id}.
The timestamp when the universe was created. This string is formatted as a Timestamp.
The timestamp when the universe was last updated. This string is formatted as a Timestamp.
The name of the universe.
This field can be updated by updating the root place's name.
The description of the universe.
This field can be updated by updating the root place's description.
The universe is user-owned.
The universe is group-owned.
Whether or not the universe is publicly accessible.
Possible values:
Value | Description |
---|---|
VISIBILITY_UNSPECIFIED | Updates using this value will throw an error on the backend. |
PUBLIC | The universe is public. |
PRIVATE | The universe is private. If a universe's visibility is set to PRIVATE, all active players will immediately be removed from all running servers. |
The Facebook social link.
The Twitter social link.
The Youtube social link.
The Twitch social link.
The Discord social link.
The Roblox group social link.
The Guilded social link.
Whether or not voice chat is enabled for users in the Experience.
Updating this value will not affect active servers.
The age rating of this universe.
Possible values:
Value | Description |
---|---|
AGE_RATING_UNSPECIFIED | The age rating is not set. |
AGE_RATING_ALL | Supported for all users. |
AGE_RATING_9_PLUS | Supported for users aged 9 and up. |
AGE_RATING_13_PLUS | Supported for users aged 13 and up. |
AGE_RATING_17_PLUS | Supported for users aged 17 and up. |
Represents the price in Robux of private servers.
If unset, private servers are not supported for this universe.
Can only be disabled when using a field mask.
Setting to null will disable all active private servers.
Changing the price will cancel all private server subscriptions.
Whether or not players can join the Experience via Desktop.
Whether or not players can join the Experience via Mobile.
Whether or not players can join the Experience via Tablet.
Whether or not players can join the Experience via Console.
Whether or not players can join the Experience via VR.
https://apis.roblox.com
{
"path": "universes/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"displayName": "ROBLOX Battle [OPEN]",
"description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
"user": "string",
"visibility": "VISIBILITY_UNSPECIFIED",
"facebookSocialLink": {
"title": "string",
"uri": "string"
},
"twitterSocialLink": {
"title": "string",
"uri": "string"
},
"youtubeSocialLink": {
"title": "string",
"uri": "string"
},
"twitchSocialLink": {
"title": "string",
"uri": "string"
},
"discordSocialLink": {
"title": "string",
"uri": "string"
},
"robloxGroupSocialLink": {
"title": "string",
"uri": "string"
},
"guildedSocialLink": {
"title": "string",
"uri": "string"
},
"voiceChatEnabled": true,
"ageRating": "AGE_RATING_UNSPECIFIED",
"privateServerPriceRobux": "integer",
"desktopEnabled": true,
"mobileEnabled": true,
"tabletEnabled": true,
"consoleEnabled": true,
"vrEnabled": true
}
Gets the specified universe.
The universe ID.
curl -L -X GET 'https://apis.roblox.com/cloud/v2/universes/{universe_id}' \
-H 'x-api-key: {your-api-key}'
{
"path": "universes/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"displayName": "ROBLOX Battle [OPEN]",
"description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
"user": "string",
"visibility": "VISIBILITY_UNSPECIFIED",
"facebookSocialLink": {
"title": "string",
"uri": "string"
},
"twitterSocialLink": {
"title": "string",
"uri": "string"
},
"youtubeSocialLink": {
"title": "string",
"uri": "string"
},
"twitchSocialLink": {
"title": "string",
"uri": "string"
},
"discordSocialLink": {
"title": "string",
"uri": "string"
},
"robloxGroupSocialLink": {
"title": "string",
"uri": "string"
},
"guildedSocialLink": {
"title": "string",
"uri": "string"
},
"voiceChatEnabled": true,
"ageRating": "AGE_RATING_UNSPECIFIED",
"privateServerPriceRobux": "integer",
"desktopEnabled": true,
"mobileEnabled": true,
"tabletEnabled": true,
"consoleEnabled": true,
"vrEnabled": true
}
Updates the specified universe.
This method is guaranteed to return all updated fields. This method may additionally return the full resource.
The universe ID.
The list of fields to update. This string is formatted as a FieldMask.
curl -L -X PATCH 'https://apis.roblox.com/cloud/v2/universes/{universe_id}?updateMask={string}' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"facebookSocialLink": {
"title": "string",
"uri": "string"
},
"twitterSocialLink": {
"title": "string",
"uri": "string"
},
"youtubeSocialLink": {
"title": "string",
"uri": "string"
},
"twitchSocialLink": {
"title": "string",
"uri": "string"
},
"discordSocialLink": {
"title": "string",
"uri": "string"
},
"robloxGroupSocialLink": {
"title": "string",
"uri": "string"
},
"guildedSocialLink": {
"title": "string",
"uri": "string"
},
"voiceChatEnabled": true,
"privateServerPriceRobux": "integer",
"desktopEnabled": true,
"mobileEnabled": true,
"tabletEnabled": true,
"consoleEnabled": true,
"vrEnabled": true
}'
{
"path": "universes/123",
"createTime": "2023-07-05T12:34:56Z",
"updateTime": "2023-07-05T12:34:56Z",
"displayName": "ROBLOX Battle [OPEN]",
"description": "OPEN SOURCE! \n Feel free to check out how we made this game and ask us about it!",
"user": "string",
"visibility": "VISIBILITY_UNSPECIFIED",
"facebookSocialLink": {
"title": "string",
"uri": "string"
},
"twitterSocialLink": {
"title": "string",
"uri": "string"
},
"youtubeSocialLink": {
"title": "string",
"uri": "string"
},
"twitchSocialLink": {
"title": "string",
"uri": "string"
},
"discordSocialLink": {
"title": "string",
"uri": "string"
},
"robloxGroupSocialLink": {
"title": "string",
"uri": "string"
},
"guildedSocialLink": {
"title": "string",
"uri": "string"
},
"voiceChatEnabled": true,
"ageRating": "AGE_RATING_UNSPECIFIED",
"privateServerPriceRobux": "integer",
"desktopEnabled": true,
"mobileEnabled": true,
"tabletEnabled": true,
"consoleEnabled": true,
"vrEnabled": true
}
Generates English speech audio from the specified text.
The universe ID.
The text to be translated.
The style of generated speech.
Contains the generated audio bytes in RFC 6716 (Opus) format.
The generated audio.
The remaining quota (remaining number of requests available to the user this calendar month).
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:generateSpeech' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"text": "Hello",
"speechStyle": {
"voiceId": "1",
"pitch": "number",
"speed": "number"
}
}'
{
"audio": "string",
"remainingQuota": "integer"
}
Generates an English speech audio asset from the specified text.
The universe ID.
The text to be translated.
The style of the generated speech.
This method is asynchronous and returns an Operation, which represents the current state of the operation. It contains an endpoint path that you can poll to obtain the real response and applicable metadata. See the documentation on long-running operations for more information.
The following sections describe the response and metadata objects that are provided when an operation completes.
Contains a generated audio asset in MPEG-2 Audio Layer III (MP3) format.
The generated audio asset ID.
The remaining quota (the remaining number of requests available to the user this calendar month).
None
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:generateSpeechAsset' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"text": "Hello",
"speechStyle": {
"voiceId": "1",
"pitch": "number",
"speed": "number"
}
}'
Publishes a message to the universe's live servers.
Servers can consume messages via MessagingService.
The universe ID.
The topic on which to publish the message.
The message to publish.
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:publishMessage' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{
"topic": "my-topic",
"message": "Hello, world!"
}'
Restarts all active servers for a specific universe if and only if a new version of the experience has been published. Used for releasing experience updates.
The universe ID.
curl -L -X POST 'https://apis.roblox.com/cloud/v2/universes/{universe_id}:restartServers' \
-H 'x-api-key: {your-api-key}' \
-H 'Content-Type: application/json' \
--data '{}'
{}