API Reference
Here you can find a complete listing of all routes available throught the Playlyfe API.
Basic routes
| Resource | Description |
|---|---|
| get /me | Returns the player's profile information. |
| post /trees | Creates a new flow tree owned by the player. |
| get /trees/:rootIds | Returns the complete list of flows, paths and actions originating at the specified root. |
| get /trees/:rootId/state | Returns a state representation providing detailed information about the current state of the flow tree originating at the specified root. |
| get /trees/:rootId/journal | Returns a simple journal detailing player's progress, useful for displaying a simple flow tracker to the player. |
Gameplay routes
| Resource | Description |
|---|---|
| post /trees/:rootId/flows/:flowId/play | Play a specified child flow originating at a specified root flow. |
Utility routes
| Resource | Description |
|---|---|
| get /trees/:rootId/flows/:flowId/logs | Returns activity logs for a child flow originating at a specified root flow. |
| get /entities/:entityId | Returns an entity by ID. |
| put /entities/:entityId | Update an existing entity. If the entity does not exist it will be created. |
| delete /entities/:entityId | Delete a stored entity. If the entity does not exist nothing happens. |