Entity

GET /get

Get entity details

This endpoint retrieves the details of a specific entity.

Parameters

Name	Type	Required	Source	Description
clientId	string		query	Client ID for the Foundry world
uuid	string		query	UUID of the entity to retrieve (optional if selected=true)
selected	boolean		query, body	Whether to get the selected entity
actor	boolean		query	Return the actor of specified entity
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Entity details object containing requested information

Try It Out

---

POST /create

Create a new entity

This endpoint creates a new entity in the Foundry world.

Parameters

Name	Type	Required	Source	Description
entityType	string	✓	body	Document type of entity to create (Scene, Actor, Item, JournalEntry, RollTable, Cards, Macro, Playlist, ext.)
data	object	✓	body	Data for the new entity
clientId	string		query	Client ID for the Foundry world
folder	string		body	Optional folder UUID to place the new entity in
keepId	boolean		body, query	If true, preserve the _id from the provided data instead of generating a new one
override	boolean		body, query	If true and keepId is set, replace any existing entity with the same ID
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the entity creation operation

Try It Out

---

PUT /update

Update an entity

This endpoint updates an existing entity in the Foundry world.

Parameters

Name	Type	Required	Source	Description
data	object	✓	body	Object containing the fields to update
clientId	string		query	Client ID for the Foundry world
uuid	string		query	UUID of the entity to retrieve (optional if selected=true)
selected	boolean		query, body	Whether to get the selected entity
actor	boolean		query	Whether to update the actor of specified entity
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the entity update operation

Try It Out

---

DELETE /delete

Delete an entity

This endpoint deletes an entity from the Foundry world.

Parameters

Name	Type	Required	Source	Description
clientId	string		query	Client ID for the Foundry world
uuid	string		query	UUID of the entity to retrieve (optional if selected=true)
selected	boolean		query, body	Whether to get the selected entity
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the entity deletion operation

Try It Out

---

POST /give

Give an item to another entity

Transfers an item from one entity to another.

Parameters

Name	Type	Required	Source	Description
clientId	string		query	Client ID for the Foundry world
fromUuid	string		body	UUID of the entity giving the item
toUuid	string		body	UUID of the entity receiving the item
selected	boolean		query, body	Whether to get the selected entity
itemUuid	string		body	UUID of the item to give
itemName	string		body	Name of the item to give (alternative to itemUuid)
quantity	number		body	Quantity of items to give
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the give operation

Try It Out

---

POST /remove

Remove an item from an entity

Removes an item from an entity's inventory.

Parameters

Name	Type	Required	Source	Description
clientId	string		query	Client ID for the Foundry world
actorUuid	string		body	UUID of the actor to remove the item from
selected	boolean		query, body	Whether to get the selected entity
itemUuid	string		body	UUID of the item to remove
itemName	string		body	Name of the item to remove (alternative to itemUuid)
quantity	number		body	Quantity of items to remove
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the remove operation

Try It Out

---

POST /decrease

Decrease an attribute

Decreases a numeric attribute of an entity by the specified amount.

Parameters

Name	Type	Required	Source	Description
attribute	string	✓	body	The attribute to decrease (e.g., hp.value)
amount	number	✓	body	The amount to decrease by
clientId	string		query	Client ID for the Foundry world
uuid	string		query	UUID of the entity to retrieve (optional if selected=true)
selected	boolean		query, body	Whether to get the selected entity
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the decrease operation

Try It Out

---

POST /increase

Increase an attribute

Increases a numeric attribute of an entity by the specified amount.

Parameters

Name	Type	Required	Source	Description
attribute	string	✓	body	The attribute to increase (e.g., hp.value)
amount	number	✓	body	The amount to increase by
clientId	string		query	Client ID for the Foundry world
uuid	string		query	UUID of the entity to retrieve (optional if selected=true)
selected	boolean		query, body	Whether to get the selected entity
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the increase operation

Try It Out

---

POST /kill

Kill an entity

Sets the entity's HP to 0.

Parameters

Name	Type	Required	Source	Description
clientId	string		query	Client ID for the Foundry world
uuid	string		query	UUID of the entity to retrieve (optional if selected=true)
selected	boolean		query, body	Whether to get the selected entity
userId	string		query, body	Foundry user ID or username to scope permissions (omit for GM-level access)

Returns

object - Result of the kill operation

Try It Out