OpenAPI descriptions

Some of the reference pages are rendered from JSON files that are OpenAPI descriptions. These files use version 3.0.4 of the OpenAPI specification.

These files are open source and can be used with tools like the Swagger Editor and Postman to test API calls and help streamline development.

These OpenAPI descriptions are still under active development and may contain issues. Use the reference and features section pages as official documentation.

OpenAPI description files

OpenAPI description files are available at the following locations within the creator-docs repository:

# Open Cloud v2

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/cloud.docs.json



# Assets

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/assets/v1.json



# Ordered Data Stores

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/ordered-v1.json



# Standard Data Stores

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/datastores-api/v1.json



# Messaging

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/messaging-service/v1.json



# Place publishing

https://github.com/Roblox/creator-docs/blob/main/content/en-us/reference/cloud/universes-api/v1.json

Vendor extensions

Roblox uses specification extensions to extend the OpenAPI specification. These extensions represent information that the specification doesn't capture by default. Extensions may appear throughout the file where allowed by the OpenAPI specification.

The majority of these specification extensions are experimental. The extensions used are subject to change without notice in favor of fields found within the official OpenAPI specification.

ExtensionLocationDescription
x-roblox-extensions-versionOpenAPI ObjectA version string, using semantic versioning, that represents the versions of the extensions specified here and other common structures
x-roblox-stabilityOperation ObjectA string that represents an operation's stability level.
x-roblox-deprecatedOperation ObjectAn object that provides additional information related to an endpoint's deprecation status.
x-roblox-alternativesOperation ObjectAn object that provides additional information related to an endpoint's alternatives.
x-roblox-rate-limitsOperation ObjectAn object that provides rate limiting information for an endpoint.
x-roblox-scopesOperation ObjectAn object that provides the list of required, conditional, and optional scopes that are associated with an endpoint.
x-roblox-engine-usabilityOperation ObjectAn object indicating the endpoint's usability with the Roblox engine.

In addition to these specification extensions, Open Cloud v2 APIs have a few additional extensions:

Open Cloud v2 specification extensions

ExtensionLocationDescription
x-categoriesOpenAPI ObjectList of strings. All resource categories.
x-visibilityOperation ObjectBoolean. The visibility of the operation.
x-roblox-docsOperation ObjectObject. Associates an operation with a category and resource.
x-long-running-operation-parametersOperation ObjectObject. References the metadata and response for the operation`s long running response.
x-aep-resourceSchema ObjectObject. An extension annotating the resource type. Has close compatibility to AEP-4, one of the API Enhancement Proposals.
x-oneOfSchema ObjectObject. Each field contains a list of properties in the schema. Only one of the properties should be present.
x-resourceSchema ObjectBoolean. Whether the schema is a resource.
x-immutableSchema ObjectBoolean. Whether the schema is immutable.