WEBP map image

Returns a webp file of a non-live copy of the current version of the specified map. Note that this export currently does not support the "Seat" layer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The identifier for the map.

Query Params
string
Defaults to #ffffff

The color the background of the map will be rendered with. Should generally be the hexadecimal color value.

number
0 to 1
Defaults to 1

The opacity of the map's background.

boolean
Defaults to true

Whether primary map objects cast a shadow on the background.

boolean
Defaults to true

Whether overlay map objects cast a shadow on the background. These objects include token-icon based map objects and text labels.

boolean

Determines whether the architecture layer will be rendered in the returned map. For all layer parameters, an affirmative inclusion (providing a 'true' value) will make the map only render the layers that are specifically called with a true value. If a layer is provided a 'false' value, then the layer will be omitted, but other layers will be included by default.

boolean

Determines whether the zones layer will be rendered in the returned map.

boolean

Determines whether the rooms layer will be rendered in the returned map.

boolean

Determines whether the furniture layer will be rendered in the returned map.

boolean

Determines whether the points of interest layer will be rendered in the returned map.

boolean

Determines whether the security infrastructure layer will be rendered in the returned map.

boolean
boolean

Determines whether the map information layer will be rendered in the returned map.

Headers
string
required

Authorization token to access the API.

Responses

400

Invalid Request

500

Server Error

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
image/webp