Studio protocol API
Reference the Studio bridge command model used by backend-owned NexusRBX workflows and the Roblox Studio plugin.
Protocol version
POST
/api/studio/toolBackend-owned endpoint shape for queueing Studio tool commands. The active protocol is 2026-06-20-phases1-9 and is validated by backend/src/lib/studioToolProtocol.js.
Command flow
| Command | Purpose | Write risk |
|---|---|---|
| get_project_manifest | List project structure and candidate scripts before source reads. | Read-only |
| search_project | Search manifest paths and object metadata. | Read-only |
| search_source | Search known source text for matches. | Read-only |
| read_script | Read a targeted script after discovery narrows the scope. | Read-only |
| write_script | Edit a known script using expectedSourceHash. | Write |
| insert_uploaded_roblox_model | Insert a trusted uploaded asset into Studio after confirmation. | Write |
Recommended command order
- Queue get_project_manifest.
- Search the manifest or indexed source.
- Read the specific script needed for the task.
- Generate an edit with expectedSourceHash.
- Snapshot and acknowledge destructive or write operations.
Important parameters
operationstring- The Studio command to execute, such as get_project_manifest, read_script, or write_script.
targetPathstring- The Studio hierarchy path for the target instance or script.
expectedSourceHashstring- Required for edits to known scripts so stale writes can return source_conflict.
idempotencyKeystring- A stable key for retryable operations so duplicate submissions can be handled safely.
applyModestring- Indicates whether a change should be held for manual review or applied by an approved workflow.
Structured errors
{ "ok": false, "code": "source_conflict", "message": "The script changed after it was read.", "targetPath": "ServerScriptService/RoundController", "recovery": "Read the script again and retry with the new expectedSourceHash."}Was this page helpful?