Assets API (assets/v1)

You can send and receive the following request and response payloads to create assets on Roblox. For information on the usage of the API, see the usage guide.

Download the original OpenAPI definition

Operations

Method	Endpoint	Summary
POST	/v1/assets	Creates an asset with provided content and metadata.
GET	/v1/assets/{assetId}	Retrieve specific asset metadata. Include the `readMask` parameter for additional asset metadata.
PATCH	/v1/assets/{assetId}	Updates an asset with provided content and metadata.
POST	/v1/assets/{assetId}:archive	Archives the asset.
POST	/v1/assets/{assetId}:restore	Restores an archived asset.
GET	/v1/assets/{assetId}/versions/{versionNumber}	Get Asset Version
GET	/v1/assets/{assetId}/versions	List Asset Versions of an Asset
POST	/v1/assets/{assetId}/versions:rollback	Rollback an asset to a previous version.
GET	/v1/operations/{operationId}	Get the result of an asset creation or update.

Schemas

Other Components

API Metadata

{
  "openapi": "3.0.1",
  "info": {
    "title": "Assets API",
    "description": "You can send and receive the following request and response payloads to create assets on Roblox. For information on the usage of the API, see the [usage guide](/cloud/guides/usage-assets.md).",
    "version": "0.0.1",
    "x-roblox-extensions-version": "1.0.0"
  },
  "servers": [
    {
      "url": "https://apis.roblox.com/assets"
    }
  ],
  "tags": [
    {
      "name": "Assets"
    }
  ]
}