get_attribute

Get the value of a single attribute on an instance

Description

Retrieves the value of a specific attribute from an instance. Supports all Roblox attribute types including primitives (string, number, boolean) and complex types (Vector3, Color3, CFrame, etc.).

Endpoint

get_attribute

Parameters

path · string · required

The path to the instance (e.g., “Workspace.Part” or “ReplicatedStorage.Config”)

name · string · required

The name of the attribute to retrieve

Response

value · any

The attribute value. Complex types are serialized as objects with type and value fields.

error · string

Error message if the instance path could not be resolved

Complex Type Serialization

Complex Roblox types are serialized as:

• Vector3: { type: "Vector3", value: [x, y, z] }
• Vector2: { type: "Vector2", value: [x, y] }
• Color3: { type: "Color3", value: [r, g, b] }
• UDim2: { type: "UDim2", value: [xScale, xOffset, yScale, yOffset] }
• UDim: { type: "UDim", value: [scale, offset] }
• NumberRange: { type: "NumberRange", value: [min, max] }
• CFrame: { type: "CFrame", value: [x, y, z, rx, ry, rz, ux, uy, uz, lx, ly, lz] }

Examples

Get a string attribute

{
  "path": "Workspace.Part",
  "name": "Description"
}

Response:

{
  "value": "This is a test part"
}

Get a Vector3 attribute

{
  "path": "Workspace.SpawnPoint",
  "name": "SpawnOffset"
}

Response:

{
  "value": {
    "type": "Vector3",
    "value": [0, 5, 0]
  }
}

Error handling

{
  "path": "Workspace.NonExistent",
  "name": "SomeAttribute"
}

Response:

{
  "error": "Instance not found: Workspace.NonExistent"
}