GET /v1/operations/{operationId} — assets/v1

Get the result of an asset creation or update.

Get the result of an asset creation or update using the returned Operation ID. Requires Read for the API key permission and asset:read for OAuth 2.0 apps.

Endpoint

Method: GET

Path: /v1/operations/{operationId}

Servers:

https://apis.roblox.com/assets

Parameters

Name	Location	Required	Description
operationId	path	true	The unique identifier of the operation.

[
  {
    "name": "operationId",
    "in": "path",
    "description": "The unique identifier of the operation.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Responses

Status	Description
200	Operation result retrieved successfully.
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": "Operation result retrieved successfully.",
    "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"
      ]
    },
    {
      "roblox-oauth2": [
        "asset:read"
      ]
    }
  ],
  "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": "Get Operation",
  "x-roblox-stability": "BETA",
  "summary": "Get the result of an asset creation or update.",
  "description": "Get the result of an asset creation or update using the returned Operation ID. Requires **Read** for the API key permission and **asset:read** for OAuth 2.0 apps.",
  "operationId": "Assets_GetOperation",
  "parameters": [
    {
      "name": "operationId",
      "in": "path",
      "description": "The unique identifier of the operation.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "responses": {
    "200": {
      "description": "Operation result retrieved successfully.",
      "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"
      ]
    },
    {
      "roblox-oauth2": [
        "asset:read"
      ]
    }
  ],
  "x-roblox-scopes": [
    {
      "name": "asset:read"
    }
  ],
  "x-roblox-cloud-api-operation-code-samples": [
    {
      "language": "Get Operation",
      "script": "curl --location 'https://apis.roblox.com/assets/v1/operations/{operationId}' \\\n--header 'x-api-key: {apiKey}'\n"
    }
  ]
}