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.

LuauExecutionSessionTaskBinaryInput — openapi

Represents a large binary input that can be given to a LuauExecutionSessionTask.

Each LuauExecutionSessionTaskBinaryInput is associated with a presigned URL which can be used to upload an arbitrary object. After uploading the object, the path of the LuauExecutionSessionTaskBinaryInput can be passed when creating a LuauExecutionSessionTask to make the object available to the task.

Within the task, the contents of the object are made available within a table passed as the first argument to the script, with the key BinaryInput. The following example demonstrates how to retrieve the data:

local taskInput: LuauExecutionTaskInput = ({...})[1]
local buf: buffer = taskInput.BinaryInput

Each LuauExecutionSessionTaskBinaryInput is valid for 15 minutes from the time of creation. Within that time, in desired, you can use it to create multiple tasks for the same universe.

The uploaded binary object must be no larger than 100 MiB.

Properties

NameTypeRequiredDescription
pathstringfalseThe resource path of the luau execution session task binary input. Format: universes/{universe_id}/luau-execution-session-task-binary-inputs/{luau_execution_session_task_binary_input_id}
sizeintegerfalseThe size of the binary input object to be uploaded. The maximum allowed size is 100 MiB.
uploadUristringfalseUpload the binary input object using this URI.

Complete Schema

{
  "type": "object",
  "properties": {
    "path": {
      "example": "universes/123/luau-execution-session-task-binary-inputs/123e4567-e89b-12d3-a456-426655440000",
      "type": "string",
      "description": "The resource path of the luau execution session task binary input.\n\nFormat:\n`universes/{universe_id}/luau-execution-session-task-binary-inputs/{luau_execution_session_task_binary_input_id}`"
    },
    "size": {
      "type": "integer",
      "description": "The size of the binary input object to be uploaded.\n\nThe maximum allowed size is 100 MiB.",
      "format": "int64",
      "x-immutable": true
    },
    "uploadUri": {
      "readOnly": true,
      "type": "string",
      "description": "Upload the binary input object using this URI."
    }
  },
  "description": "Represents a large binary input that can be given to a\n`LuauExecutionSessionTask`.\n\nEach `LuauExecutionSessionTaskBinaryInput` is associated with a presigned URL\nwhich can be used to upload an arbitrary object. After uploading the object,\nthe path of the `LuauExecutionSessionTaskBinaryInput` can be passed when\ncreating a `LuauExecutionSessionTask` to make the object available to the\ntask.\n\nWithin the task, the contents of the object are made available within a table\npassed as the first argument to the script, with the key `BinaryInput`. The\nfollowing example demonstrates how to retrieve the data:\n\n```\nlocal taskInput: LuauExecutionTaskInput = ({...})[1]\nlocal buf: buffer = taskInput.BinaryInput\n```\n\nEach `LuauExecutionSessionTaskBinaryInput` is valid for 15 minutes from the\ntime of creation. Within that time, in desired, you can use it to create\nmultiple tasks for the same universe.\n\nThe uploaded binary object must be no larger than 100 MiB.",
  "x-aep-resource": {
    "patterns": [
      "universes/{universe_id}/luau-execution-session-task-binary-inputs/{luau_execution_session_task_binary_input_id}"
    ],
    "plural": "luau-execution-session-task-binary-inputs",
    "singular": "luau-execution-session-task-binary-input"
  },
  "x-resource": true
}