World Data API

World Data API (Removed)

Deprecated in v7.0.0. The REST push mechanism (POST /update, POST /update-compendium) has been removed. World data is now pulled on-demand via WebSocket commands.

Replacement

Use these WebSocket commands to retrieve world data as needed:

• get-world-info — World metadata (system, version, etc.)
• get-actors / filter-actors / get-actor — Actor documents (filter-actors supports D&D 5e-aware filters: CR, level, HP, AC, abilities, creature type, size, disposition, folder)
• get-journals / get-journal — Journal entries and pages
• get-items / get-item — Item documents
• get-compendiums / get-compendium — Compendium packs and contents
• get-scene / get-scenes-list — Scene documents

See WebSocket API for full command reference.