Basic Operations

Simple examples for getting instance info, setting properties, and creating objects

Get Instance Information

Query information about instances in your place using various tools.

Get Instance Properties

Retrieve all properties of a specific instance:

Request

{
  "path": "Workspace.Baseplate"
}

Search for Objects

Find instances by name or class:

By Name

{
  "query": "SpawnLocation",
  "path": "Workspace",
  "limit": 10
}

Get File Tree

Explore the hierarchy of your place:

Request

{
  "path": "Workspace",
  "depth": 2,
  "limit": 50
}

Set Properties

Modify instance properties with type-safe serialization.

Set a Single Property

Simple Value

{
  "path": "Workspace.MyPart",
  "property": "Transparency",
  "value": 0.5
}

Set Relative Property

Modify a property relative to its current value:

Move Up by 5 Studs

{
  "path": "Workspace.MyPart",
  "property": "Position",
  "delta": {
    "type": "Vector3",
    "value": [0, 5, 0]
  }
}

set_relative_property supports numeric, Vector2, Vector3, UDim2, and CFrame types. For CFrame, the delta is multiplied (not added).

Create Objects

Instantiate new instances in your place.

Create Simple Object

Request

{
  "path": "Workspace",
  "className": "Part"
}

Create Object with Properties

Create an instance and set its properties in one operation:

Create Red Part

{
  "path": "Workspace",
  "className": "Part",
  "properties": {
    "Name": "RedPart",
    "Position": {
      "type": "Vector3",
      "value": [0, 10, 0]
    },
    "Size": {
      "type": "Vector3",
      "value": [4, 1, 2]
    },
    "Color": {
      "type": "Color3",
      "value": [1, 0, 0]
    },
    "Anchored": true,
    "Material": "Neon"
  }
}

Create with Attributes

You can also set attributes when creating objects:

Request

{
  "path": "Workspace",
  "className": "Part",
  "properties": {
    "Name": "CustomPart"
  },
  "attributes": {
    "Health": 100,
    "MaxHealth": 100,
    "Team": "Blue",
    "SpawnOffset": {
      "type": "Vector3",
      "value": [0, 3, 0]
    }
  }
}

Working with Attributes

Manage custom attributes on instances.

Get All Attributes

Request

{
  "path": "Workspace.CustomPart"
}

Set Individual Attribute

Request

{
  "path": "Workspace.CustomPart",
  "name": "Health",
  "value": 75
}

Working with Tags

Use CollectionService tags to organize instances.

Add Tag

Request

{
  "path": "Workspace.MyPart",
  "tag": "Interactive"
}

Get All Tagged Instances

Request

{
  "tag": "Interactive"
}

Next Steps

Script Editing

Learn how to read and modify script source code

Bulk Operations

Efficiently modify multiple instances at once