Skip to main content

FoundryVTT REST API Reference

This is the API reference for the FoundryVTT REST API Relay server.

Available Endpoints​

The API is divided into several resource groups:

  • DnD5e - D&D 5th Edition specific endpoints
  • Encounter - Combat encounter management
  • Entity - General entity manipulation (actors, items, etc.)
  • File System - File management operations
  • Macro - Execute and manage macros
  • Roll - Perform dice rolls
  • Search - Search the Foundry database
  • Session - Manage headless Foundry sessions
  • Sheet - Interact with character sheets
  • Structure - Get information about world structure
  • Utility - Miscellaneous utility endpoints

Each endpoint is documented with its path, HTTP method, required and optional parameters, and expected response format.

Authentication​

Most API endpoints require authentication with an API key. Provide your API key in the x-api-key header with each request.