Read one document of any type
get-documentRead-onlyIdempotent
Retrieve any Foundry VTT document by UUID or type and ID, selecting only needed fields or handling large documents via chunked responses.
Instructions
Generic fallback: read one document of any type by uuid, or by documentType and id (with parentUuid for an embedded document, pack for a compendium), whole or only the given fields. A large answer comes in parts: call again with chunkStart and the fingerprint of the first part and join the parts. embedded "summary" shortens embedded collections to ids and names. Prefer get-character, get-current-scene, get-roll-table, get-compendium-item and get-token-details where they fit.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | No | Id of the document, together with documentType | |
| pack | No | Compendium id "package.name" to read from; compendiums are read only here | |
| uuid | No | uuid of the document, e.g. "Actor.abc", "Scene.abc.Token.def", "Compendium.dnd5e.monsters.Actor.abc" | |
| fields | No | Dotted paths to return, list positions as ".0" or "[0]" and "*" for every entry, e.g. "system.attributes.hp.value", "items.*.name". ["*"] returns all data | |
| embedded | No | Embedded documents in full or as ids and names; default include | |
| maxChars | No | Character budget of the answer, 1000 to 200000; default 60000 | |
| chunkStart | No | Character position to continue from, from the previous part | |
| parentUuid | No | uuid of the document that holds an embedded one, e.g. "Actor.abc" for its items, "Scene.abc" for its walls | |
| fingerprint | No | Fingerprint of the first part, so a change in between is noticed | |
| documentType | No | Foundry document name, e.g. "Actor", "JournalEntryPage", "Combat", "Wall"; with id when no uuid is given |