Browse API Reference

Render equipment artwork

Return the finished PNG artwork associated with a stable equipment id and publishable key.

Use the image template returned by an equipment record and replace {publishableKey} with the publishable half of your key.

GET /v1/{publishableKey}/equipment/{id}.png
HTML
<img
  src="https://cdn.gymassets.dev/v1/{key}/equipment/dumbbell.png"
  alt="Dumbbell"
/>
Response ยท image/png 200
content-type: image/png
cache-control: public, max-age=3600
access-control-allow-origin: *
etag: "8857b29197ed55b0149bf1ae70df448d"

Path parameters

ParameterBehavior
publishableKeyAuthorizes the image request and assigns it to the Equipment allowance
idA stable id returned by /v1/equipment

The only supported format is PNG. These are stored finished renders rather than images resized or themed at request time โ€” for artwork that follows your palette, use the icon route.