List Foundry VTT worlds connected to the relay, including their connection status and Foundry version.

Get the relay's currently resolved Foundry world. With a scoped key this identifies its clientId without FOUNDRY_CLIENT_ID.

List Foundry users as id, name, role, isGM, active, and avatar. Requires relay scope user:read and GM access; clientId is auto-resolved for a scoped key.

Create a Foundry service or bot user. Requires relay scope user:write and GM access. The tool never accepts, returns, or logs a password.

Read folders and document references from a Foundry world.

Get one Foundry document by UUID, such as Actor.abc123.

Search world entities and compendiums.

Create a Foundry world entity.

Update a Foundry entity by UUID or the current selection.

Delete a Foundry entity by UUID or the current selection.

Add Items or ActiveEffects to one actor. Item creation uses the relay's supported Actor items upsert.

Update Items or ActiveEffects embedded in one actor.

Delete Items or ActiveEffects embedded in one actor.

Get a folder and its contents by name.

Create a Foundry folder.

Delete a Foundry folder; deleteAll also deletes its contents.

List files and directories in a Foundry file source.

Download a file from a Foundry file source.

Upload a base64-encoded file or data URL to a Foundry file source.

Get one or more scenes.

Create a new scene.

Update a scene by ID, name, or active status.

Delete a scene by ID or name.

Switch the player-facing active scene.

Get canvas embedded documents from a scene.

Create one or more canvas embedded documents.

Update one canvas embedded document.

Delete one canvas embedded document.

Move a token to canvas coordinates.

Measure distance between two points or tokens.

Select tokens in the Foundry client.

Get tokens selected in the Foundry client.

List active encounters.

Start an encounter.

Advance to the next encounter turn.

Return to the previous encounter turn.

Advance to the next encounter round.

Return to the previous encounter round.

End an encounter.

Add selected or named tokens to an encounter.

Remove selected or named tokens from an encounter.

Get active effects on an actor or token.

List status effects supported by the game system.

Add a status or custom active effect.

Remove an active effect by ID or status.

Roll a dice formula.

Get the latest roll.

Get recent rolls.

Get chat messages with optional pagination and filters.

Create a chat message.

Create a chat message as a Foundry user and verify the returned ChatMessage.author.id. The relay permits this only for the API key's scoped user, or for a GM key; scoped keys cannot be overridden.

Delete one chat message.

Permanently clear all chat messages.