Planisfy
Api

Sprites API

Serve published MapLibre sprite metadata and PNG atlases for Planisfy styles.

Sprites API

Published style sprite paths live under the style URL namespace.

Routes

MethodRouteDescription
GET/styles/v1/{owner}/{style}/sprite.jsonStandard-resolution sprite metadata.
GET/styles/v1/{owner}/{style}/sprite.pngStandard-resolution sprite atlas.
GET/styles/v1/{owner}/{style}/[email protected]High-resolution sprite metadata.
GET/styles/v1/{owner}/{style}/[email protected]High-resolution sprite atlas.

Published style JSON includes a sprite base URL when the published style references sprite assets:

{
  "sprite": "/styles/v1/{owner}/{style}/sprite"
}

Auth and caching

Sprite access follows the parent style access rules. Public styles can serve sprites anonymously. Private styles require owner context from a valid API key or session.

Sprite responses use the style cache policy and an ETag.

Common errors

CodeMeaning
NOT_FOUNDStyle, owner, version, or sprite asset was not found.
FORBIDDENThe style is private and the request lacks owner access.
VALIDATION_ERRORThe style version suffix is invalid.

Styles without sprite assets return 404 Sprite not configured.

On this page