render_static
A PNG of a place: centre, zoom, size and a look, with optional markers, lines and areas drawn on top; leave out the centre and zoom to fit the picture to what is drawn. To picture a route, pass the directions tool's geometry as a path "color,width,enc6:" with pins at its ends. Studio plan and above. Returns the image, a signed URL that works anywhere (email, chat, a page) with no key in it, and the plain URL for use with a publishable key on a site. A given picture (overlays included) counts one static map image against the workspace's monthly allowance once a week, however often it is viewed. Past the allowance the tool returns images_exhausted and nothing is charged.
Tool call template
This tool declares no required parameters. Add optional parameters from the input schema as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {},
"name": "render_static"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| zoom | No | 0 (the world) to 20 (a building). Streets read well at 14 to 16. Required with a centre. | |
| paths | No | Lines, each "color,width,lng,lat,lng,lat,…" (up to 100 points) or "color,width,enc6:<polyline6>" for a route's geometry from the directions tool (up to 4,000 points, thinned to 500): color 3/6 hex, width 1–16. E.g. "0a84ff,4,-6.2,53.3,-6.3,53.4". | |
| pitch | No | Tilt in degrees, 0 to 60. | |
| style | No | A built-in look (meadow, midnight, neon, vintage, blueprint, sakura), a published style id, id@version, or one of the workspace's style URLs. Default meadow. | |
| width | No | Pixels, 1 to 1280. Default 600. | |
| center | No | [longitude, latitude] of the map's centre. Omit it (and zoom) to fit the picture to the markers, paths and areas. | |
| height | No | Pixels, 1 to 1280. Default 400. | |
| key_id | No | The map key (uuid from list_keys) to count the image against and sign the URL with. Default: the workspace's first active secret key, else its first publishable one. | |
| retina | No | Render at 2x for high-density screens; the image is twice the pixels. | |
| bearing | No | Rotation in degrees, 0 to 360. | |
| markers | No | Pins and dots to drop on the map, each "lng,lat[,icon][,color][,label]": icon is pin (default), pin-sm or dot; color is 3/6 hex without '#'; label is one or two letters or digits. E.g. "-6.26,53.35,pin,e11d48,A". Up to 20. | |
| language | No | Label language, e.g. "en", "de", "ja", "zh-Hans" (41 in all); omit for local names. | |
| polygons | No | Filled areas, each "fill,stroke,lng,lat,lng,lat,…" (three or more points). E.g. "e11d48,111111,-6.2,53.3,-6.3,53.3,-6.3,53.4". |