POST /v1/assets — assets/v1

Creates an asset with provided content and metadata.

You can't add SocialLink objects when you create an asset. Instead, use Update Asset.

Provide the Asset, binary asset file path, and content type in the form data.

Endpoint

Method: POST

Path: /v1/assets

Servers:

https://apis.roblox.com/assets

Request Body

{
  "content": {
    "multipart/form-data": {
      "schema": {
        "type": "object",
        "properties": {
          "request": {
            "$ref": "#/components/schemas/Asset",
            "description": "Asset attributes to create."
          },
          "fileContent": {
            "type": "string",
            "format": "binary",
            "description": "The binary asset file path and the content type. See [Asset types and limits](/cloud/guides/usage-assets.md#supported-asset-types-and-limits)."
          }
        },
        "required": [
          "request",
          "fileContent"
        ]
      }
    }
  }
}

Responses

Status	Description
200	Returns the Operation ID for checking the creation status.
400	Invalid argument. Failed to parse the request or the file.
401	The API key is not valid for this operation / You don't have the authorization.
500	Server internal error / Unknown error.

{
  "200": {
    "description": "Returns the Operation ID for checking the creation status.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Operation"
        }
      }
    }
  },
  "400": {
    "description": "Invalid argument. Failed to parse the request or the file.",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/Status"
        }
      }
    }
  },
  "401": {
    "description": "The API key is not valid for this operation / You don't have the authorization."
  },
  "500": {
    "description": "Server internal error / Unknown error."
  }
}

Authentication

{
  "security": [
    {
      "roblox-api-key": [
        "asset:read",
        "asset:write"
      ]
    },
    {
      "roblox-oauth2": [
        "asset:read",
        "asset:write"
      ]
    }
  ],
  "securitySchemes": {
    "roblox-api-key": {
      "type": "apiKey",
      "description": "A configurable key that allows granular access to Roblox resources. See https://create.roblox.com/docs/cloud/auth/api-keys for more information.",
      "in": "header",
      "name": "x-api-key"
    },
    "roblox-oauth2": {
      "type": "oauth2",
      "description": "Build or authorize apps to access Roblox resources. See https://create.roblox.com/docs/cloud/auth/oauth2-overview for more information.",
      "flows": {
        "authorizationCode": {
          "authorizationUrl": "https://apis.roblox.com/oauth/v1/authorize",
          "tokenUrl": "https://apis.roblox.com/oauth/v1/token",
          "refreshUrl": "https://apis.roblox.com/oauth/v1/token",
          "scopes": {
            "asset:read": "This allows viewing information about your assets.",
            "asset:write": "This allows uploading and updating assets to Roblox."
          }
        }
      }
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Assets"
  ],
  "x-roblox-cloud-api-operation": true,
  "x-roblox-cloud-api-operation-name": "Create Asset",
  "x-roblox-stability": "BETA",
  "summary": "Creates an asset with provided content and metadata.",
  "description": "Creates an asset with provided content and metadata.\n\nYou can't add [SocialLink](#SocialLink) objects when you create an asset. Instead, use [Update Asset](#PATCH-v1-assets-_assetId_).\n\nProvide the [Asset](#Asset), binary asset file path, and [content type](/cloud/guides/usage-assets.md#supported-asset-types-and-limits) in the form data.",
  "operationId": "Assets_CreateAsset",
  "requestBody": {
    "content": {
      "multipart/form-data": {
        "schema": {
          "type": "object",
          "properties": {
            "request": {
              "$ref": "#/components/schemas/Asset",
              "description": "Asset attributes to create."
            },
            "fileContent": {
              "type": "string",
              "format": "binary",
              "description": "The binary asset file path and the content type. See [Asset types and limits](/cloud/guides/usage-assets.md#supported-asset-types-and-limits)."
            }
          },
          "required": [
            "request",
            "fileContent"
          ]
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Returns the Operation ID for checking the creation status.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Operation"
          }
        }
      }
    },
    "400": {
      "description": "Invalid argument. Failed to parse the request or the file.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    },
    "401": {
      "description": "The API key is not valid for this operation / You don't have the authorization."
    },
    "500": {
      "description": "Server internal error / Unknown error."
    }
  },
  "security": [
    {
      "roblox-api-key": [
        "asset:read",
        "asset:write"
      ]
    },
    {
      "roblox-oauth2": [
        "asset:read",
        "asset:write"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "asset:read"
    },
    {
      "name": "asset:write"
    }
  ],
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "Create Asset",
      "script": "curl --location --request POST 'https://apis.roblox.com/assets/v1/assets' \\\n--header 'x-api-key: {apiKey}' \\\n--form 'request=\"{ \n  \\\"assetType\\\": \\\"Model\\\",  \n  \\\"displayName\\\": \\\"Name\\\", \n  \\\"description\\\": \\\"This is a description\\\", \n  \\\"creationContext\\\": { \n    \\\"creator\\\": { \n      \\\"userId\\\": \\\"${userId}\\\" \n    } \n  } \n}\"' \\\n--form 'fileContent=@\"/filepath/model.fbx\";type=model/fbx' \n"
    }
  ]
}