POST /cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-session-tasks — cloud.docs

Create Luau Execution Session Task

Creates a task but does not wait for the task to complete.

To check whether a task has completed, call the GetLuauExecutionSessionTask method and inspect the state field of the returned resource.

Endpoint

Method: POST

Path: /cloud/v2/universes/{universe_id}/places/{place_id}/versions/{version_id}/luau-execution-session-tasks

Servers:

https://apis.roblox.com

Parameters

Name	Location	Required	Description
universe_id	path	true	The universe ID.
place_id	path	true	The place ID.
version_id	path	true	The version ID.

[
  {
    "name": "universe_id",
    "in": "path",
    "description": "The universe ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "place_id",
    "in": "path",
    "description": "The place ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  },
  {
    "name": "version_id",
    "in": "path",
    "description": "The version ID.",
    "required": true,
    "schema": {
      "type": "string"
    }
  }
]

Request Body

{
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/LuauExecutionSessionTask"
      }
    }
  },
  "required": true
}

Responses

Status	Description
200	OK

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

Authentication

{
  "security": [],
  "securitySchemes": {}
}

LuauExecutionSessionTask

Complete Operation Definition

{
  "tags": [
    "Cloud"
  ],
  "summary": "Create Luau Execution Session Task",
  "description": "Creates a task but does not wait for the task to complete.\n\nTo check whether a task has\ncompleted, call the `GetLuauExecutionSessionTask` method and inspect the\n`state` field of the returned resource.",
  "operationId": "Cloud_CreateLuauExecutionSessionTask__Using_Universes_Places",
  "parameters": [
    {
      "name": "universe_id",
      "in": "path",
      "description": "The universe ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "place_id",
      "in": "path",
      "description": "The place ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    },
    {
      "name": "version_id",
      "in": "path",
      "description": "The version ID.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/LuauExecutionSessionTask"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/LuauExecutionSessionTask"
          }
        }
      }
    }
  },
  "x-visibility": "STABLE",
  "x-roblox-engine-usability": {
    "apiKeyWithHttpService": false
  },
  "x-roblox-scopes": [
    {
      "name": "universe.place.luau-execution-session:write"
    }
  ],
  "x-roblox-docs": {
    "category": "Luau execution",
    "methodProperties": {
      "scopes": [
        "universe.place.luau-execution-session:write"
      ]
    },
    "resource": {
      "$ref": "#/components/schemas/LuauExecutionSessionTask",
      "name": "LuauExecutionSessionTask"
    }
  }
}