Quick Start

Get up and running with the FoundryVTT REST API Relay in minutes:

# Clone and start with Docker
git clone https://github.com/JustAnotherIdea/foundryvtt-rest-api-relay.git
cd foundryvtt-rest-api-relay
docker-compose up -d

# Server available at http://localhost:3010

Example API Call

Search for entities in your FoundryVTT world:

curl -X GET "http://localhost:3010/api/search" \
  -H "x-api-key: your-api-key" \
  -H "x-client-id: your-client-id" \
  -G -d "query=goblin" -d "type=Actor"