Get an exercise

Return one exercise record with its muscles, equipment ids, and the image templates for its illustration.

Read a single record by its id when your application has stored one, or take records from the collection and skip the extra request.

GET https://api.gymassets.dev/v1/exercises/{id}

cURL

curl 'https://api.gymassets.dev/v1/exercises/myfv' \
  -H "Authorization: Bearer $GA_SECRET_KEY"

Response · application/json 200

{
  "id": "myfv",
  "slug": "standing-curl-with-barbell",
  "name": "curl with barbell",
  "category": "strength",
  "difficulty": "beginner",
  "posture": "standing",
  "movement": "biceps-curl",
  "grip": "underhand",
  "muscles": { "primary": ["biceps"], "secondary": ["forearms"] },
  "equipment": ["barbell"],
  "frames": [
    {
      "frame": "start",
      "figure": "male",
      "image": "https://cdn.gymassets.dev/v1/{publishableKey}/exercises/myfv/male/start.webp",
      "maskPrimary": "https://cdn.gymassets.dev/v1/{publishableKey}/exercises/myfv/male/start-mask-primary.png",
      "maskSecondary": "https://cdn.gymassets.dev/v1/{publishableKey}/exercises/myfv/male/start-mask-secondary.png"
    }
  ]
}

An unknown id returns 404.

Response fields

Field	Contents
`id`	The record’s identity and its art address. Four characters, permanent. Store this
`slug`	A readable name for the record. It may change; it never appears in an address
`name`	Display name
`category`, `difficulty`, `posture`, `movement`, `grip`	Classification ids, each from its vocabulary
`description`	Prose description of the movement
`muscles`	Two arrays, `primary` and `secondary` — the two parameters a muscle diagram render takes
`equipment`	Equipment ids, resolvable against the Equipment API
`frames`	One entry per published illustration frame, with ready image templates

category, difficulty, posture, movement, grip, and description are omitted when no value is established. They are never returned as null.

frames lists published drawings only, and is an empty array when none exist yet. Replace {publishableKey} in its templates with the publishable half of your key. maskSecondary is present only when the record lists secondary muscles.