Skip to main content

​
Description

Returns information about a Roblox class, including its available properties. This uses the StudioService API to fetch class metadata. Note: This API is only available in Studio edit mode and may not work in all contexts.

​
HTTP Endpoint

POST /tool/get_class_info

​
Request Parameters

​
className
string
required
The name of the Roblox class. Examples: "Part", "Script", "Frame", "RemoteEvent"

​
Response Format

​
className
string
The class name that was queried
​
properties
array
Array of property information objects (structure depends on StudioService API)
​
note
string
Information message if the API is unavailable

​
Example

const response = await fetch('http://127.0.0.1:7766/tool/get_class_info', {
  method: 'POST',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    className: 'Part'
  })
});

const data = await response.json();
console.log(data.result);

// Example output (when available):
// {
//   "className": "Part",
//   "properties": [
//     // Property metadata from StudioService
//   ]
// }

// Example output (when unavailable):
// {
//   "className": "Part",
//   "note": "StudioService API unavailable in this context"
// }

​
Implementation Details

From InstanceTools.lua:279-291:
  • Uses StudioService:GetClassProperties() to fetch class metadata
  • Wrapped in pcall for graceful failure
  • Returns informative message when API is unavailable
  • Only works in Studio edit mode

Build docs developers (and LLMs) love

Get started for freeTalk to us