MCP & API
back to documentation

MCP & API

Connect supported external workflows and use the REST API reference safely.

Interactions

Portals interactions are best created and maintained in Interactive Studio. The public REST API does not offer a standalone, typed endpoint for hand-authoring triggers, effects, or task graphs.

This boundary is intentional. An interaction can depend on the selected item, its runtime data, task state, and the player experience. A low-level snapshot edit is easy to corrupt and difficult to test.

What a room-data snapshot carries

A downloaded room-data snapshot can include:

  • roomTasks for game-level task data.
  • Per-item extra data transported in the logic map.
  • Item records in roomItems that may reference interaction behavior.

These sections are preserved by the room-data import workflow, but their internal structures are not a public contract for assembling new gameplay from scratch.

Recommended workflow

  1. Build the player behavior in Interactive Studio first.
  2. Test it by starting at the intended spawn point and performing the player action.
  3. If you need automation, use MCP to inspect and apply a scoped workflow in a test game.
  4. Use a room-data snapshot only when you must preserve an existing, known-good interaction while making a focused surrounding change.
  5. Download a backup before every import.

Do not hand-author task data from this page

Avoid copying raw trigger or effect payloads into a room snapshot. A field that happens to work in one game can depend on item identifiers, placement, variables, or runtime state in another game.

For the documented no-code model, see:

For a custom interface or supported script, see Code & Custom UI.

A safe test sequence

When changing an interaction-adjacent snapshot:

  1. Duplicate the game or use a test game.
  2. Download the current snapshot and preserve it unchanged.
  3. Change only the field you can explain.
  4. Import it through the documented room-data workflow.
  5. Join as a player and test the behavior from the correct starting condition.
  6. Keep the backup until the test game behaves as expected.

If the change is only visual or metadata, do not touch interaction data at all.