Core concepts
The ids, keys, themes, vocabularies, and request surfaces shared by GymAssets products.
These concepts are the contract between GymAssets data and artwork. Learn them once and the same model applies across product APIs.
Stable ids
An id is the join between a record and its asset. pectorals is both a muscle in
the data API and a value accepted by primary on a muscle diagram. dumbbell is
both an equipment record and the leaf of its artwork URL.
Store ids in your data. Display labels to people.
Publishable and secret keys
A key is issued as a pair:
| Half | Used for | Where it belongs |
|---|---|---|
pk_… | Image requests | Client-visible image URLs |
sk_… | Data requests | Your server |
Image and data APIs
Image requests return bytes and are designed to sit directly in an <img> element.
Data requests return JSON and use an Authorization header. An image URL should not
be called with a secret key, and a data route refuses a publishable key.
Themes
A Musclegram theme belongs to the key, not to an exported set of files. Existing URLs pick up palette changes after the edge cache refreshes. Equipment renders are finished artwork and do not use the Musclegram palette.
Vocabularies
Vocabularies publish the accepted values for filters such as equipment category, equipment loading, muscle region, figure, and side. Build controls from those responses instead of hard-coding options.
Collections and members
A collection returns a page under data and may include next. A member route
returns one record directly. Follow next as an opaque cursor. There is no page
number and no client-selected page size.