3 min read

Source: Roblox Creator Hub · CC BY 4.0 · View source · Code samples: MIT Imported 2026-10-03. Formatting adapted for this site.

Errors

The following sections describe the error handling for Open Cloud APIs. Due to implementation differences across endpoints and validation layers, error responses can vary significantly in format.

Gateway errors

For authentication or routing issues, both Open Cloud v1 and v2 APIs may return errors in this format:

{
  "errors": [
    {
      "code": 0,
      "message": "Invalid API Key"
    }
  ]
}

Open Cloud v2

Open Cloud v2 APIs generally follow a consistent error format when the error occurs within the API endpoint itself.

Standard v2 error format

Open Cloud v2 APIs return errors in this format:

• code - A string representing the error type (e.g. INVALID_ARGUMENT, NOT_FOUND).
• message - A human-readable message explaining the error.
• details - An optional array containing additional error-specific information.

{
  "code": "INVALID_ARGUMENT",
  "message": "Invalid User ID in the request."
}

{
  "code": "INVALID_ARGUMENT",
  "message": "The provided filter is invalid.",
  "details": [
    {
      ...
    }
  ]
}

v2 error codes

The following table describes possible values for code in v2 API responses.

Open Cloud v1

Open Cloud v1 APIs have inconsistent error response formats. The format depends on the specific endpoint, the type of error, and where the error occurs in the request processing pipeline.

Most v1 endpoints return errors in one of these three formats:

{
  "error": "INVALID_ARGUMENT",
  "message": "Invalid cursor.",
  "errorDetails": [
    {
      "errorDetailType": "DatastoreErrorInfo",
      "datastoreErrorCode": "InvalidCursor"
    }
  ]
}

{
  "code": "INVALID_ARGUMENT",
  "message": "Invalid cursor."
}

{
  "errors": {
    "assetId": ["The value 'a' is not valid."]
  },
  "type": "https://tools.ietf.org/html/rfc9110#section-15.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "extensions": {
    "traceId": "00-427917f0fc3b8375ee33e4603a7f0693-f3f6ad560ff1a122-00"
  }
}

v1 error codes

The following table describes possible values for error or code in v1 API responses: