API Reference
Authenticate GymAssets requests, choose an image or data API, and open the operation that matches what you need to build.
GymAssets serves finished images from a publishable URL and structured catalogue data from a server-authenticated REST API. Both surfaces use the same ids. A record points straight at its matching artwork.
| Surface | Base address | Returns | Authentication |
|---|---|---|---|
| Image API | cdn.gymassets.dev/v1 | WebP or PNG | Publishable key in the path |
| Data API | api.gymassets.dev/v1 | JSON | Secret key in a bearer header |
Products
Musclegram API
Render themed anatomy, list muscles, inspect one muscle, and discover coverage vocabularies.
Equipment API
Render equipment artwork, list and filter equipment, fetch one record, and discover filter vocabularies.
Authenticate a data request
curl 'https://api.gymassets.dev/v1/muscles' \
-H "Authorization: Bearer $GA_SECRET_KEY"The data API accepts GET, HEAD, and CORS preflight requests. Collection routes
return cursor-paginated results. Member routes return one record directly.
Platform behavior
API keys
Use the publishable and secret halves in the correct places.
Rate limits
Handle burst refusals and monthly product allowances.
Errors
Read status codes and stable error identifiers.
Pagination
Walk a collection with a cursor and keep the walk correct.
Caching
Keep URLs stable and understand when changed themes appear.
CORS
Load artwork anywhere and read render diagnostics from script.