Skip to main content
Creates a new Roblox instance of the specified class and parents it to the given path.

​
Endpoint

create_object

​
Parameters

​
path
string
required
The path to the parent instance where the new object will be created (e.g., "game.Workspace", "game.ReplicatedStorage").
​
className
string
required
The Roblox class name of the instance to create (e.g., "Part", "Folder", "Script").

​
Response

​
ok
boolean
Returns true if the object was created successfully.
​
path
string
The full path to the newly created object.
​
name
string
The name of the newly created object.
​
error
string
Error message if the operation failed. Common errors include:
  • Invalid path resolution
  • Invalid className

​
Examples

​
Create a Part in Workspace

{
  "path": "game.Workspace",
  "className": "Part"
}
Response: 
{
  "ok": true,
  "path": "Workspace.Part",
  "name": "Part"
}

​
Create a Folder in ReplicatedStorage

{
  "path": "game.ReplicatedStorage",
  "className": "Folder"
}
Response: 
{
  "ok": true,
  "path": "ReplicatedStorage.Folder",
  "name": "Folder"
}

​
Error: Invalid ClassName

{
  "path": "game.Workspace",
  "className": "InvalidClass"
}
Response: 
{
  "error": "Invalid className: InvalidClass"
}

​
Notes

  • The created object will have default properties for its class
  • To create an object with custom properties, use create_object_with_properties
  • The object is automatically parented after creation

Build docs developers (and LLMs) love

Get started for freeTalk to us