2 min read

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

POST /open-eval-api/v1/eval — open-eval-api/v1

Performs the evaluation of the Lua script.

Endpoint

Method: POST

Path: /open-eval-api/v1/eval

Servers:

Request Body

{
  "content": {
    "application/json-patch+json": {
      "schema": {
        "$ref": "#/components/schemas/EvalRequest"
      }
    },
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/EvalRequest"
      }
    },
    "text/json": {
      "schema": {
        "$ref": "#/components/schemas/EvalRequest"
      }
    },
    "application/*+json": {
      "schema": {
        "$ref": "#/components/schemas/EvalRequest"
      }
    }
  }
}

Responses

StatusDescription
200OK
{
  "200": {
    "description": "OK",
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/EvalResponse"
        }
      }
    }
  }
}

Authentication

{
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    }
  ],
  "securitySchemes": {
    "roblox-legacy-cookie": {
      "type": "apiKey",
      "description": "A browser cookie that represents the identity of a Roblox user. DO NOT SHARE THIS. Sharing this will allow someone to log in as you and to steal your Robux and items. When possible, use API keys with the x-api-key header or OAuth 2.0 instead for authentication.",
      "in": "cookie",
      "name": ".ROBLOSECURITY"
    },
    "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"
    }
  }
}

Complete Operation Definition

{
  "tags": [
    "Eval"
  ],
  "summary": "Performs the evaluation of the Lua script.",
  "requestBody": {
    "content": {
      "application/json-patch+json": {
        "schema": {
          "$ref": "#/components/schemas/EvalRequest"
        }
      },
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/EvalRequest"
        }
      },
      "text/json": {
        "schema": {
          "$ref": "#/components/schemas/EvalRequest"
        }
      },
      "application/*+json": {
        "schema": {
          "$ref": "#/components/schemas/EvalRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/EvalResponse"
          }
        }
      }
    }
  },
  "x-roblox-stability": "BETA",
  "x-roblox-rate-limits": {
    "perApiKeyOwner": {
      "period": "DAY",
      "maxInPeriod": 100
    }
  },
  "x-roblox-scopes": [
    {
      "name": "studio-evaluations:create"
    }
  ],
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "security": [
    {
      "roblox-legacy-cookie": []
    },
    {
      "roblox-api-key": []
    }
  ]
}