Home

How to use Foundry REST API:

• Install the Foundry VTT Module

• Get an API key for the public relay server at https://foundryvtt-rest-api-relay.fly.dev/

• Download Postman and the import the latest API Test Collection for an easy way to start testing endpoints.

• Read this documentation for information about how to use each endpoint

---

Foundry REST API provides various API endpoints for fetching and interacting with your foundry world data through a node.js server that act as a relay.

Getting started guide

To start using the Foundry REST API, you need to -

• Have your API key in the module settings.

• Each request must have the your API key in the "x-api-key" header.

• Endpoints other than /clients require a clientId parameter that matches a connected world.