Exercises

Get a single exercise by ID or slug

get/exercises/{id}

Request

  • Base URL: https://exercise-api.ymove.app/api/v2
  • URL: https://exercise-api.ymove.app/api/v2/exercises/{id}
  • Auth: one of:
    • API key in header X-API-Key
    • API key in query parameter api_key

Path parameters

idstring required

Exercise UUID or slug

Query parameters

excludeVideosboolean

Videos are included by default here - you asked for one specific exercise, you probably want to play it. Pass excludeVideos=1 to get the metadata without the video URLs, in which case this exercise does not count toward your monthly cap. Thumbnails come with it on Scale; on the capped plans they go with the video. includeVideos=false does the same thing.

Response

Exercise details. Videos are included by default; pass excludeVideos=1 for metadata and thumbnails only, which costs nothing. When the monthly exercise cap is exceeded and this exercise was not previously accessed, the video URLs are removed and a _warning is included. Thumbnails accompany any returned video; on Scale they are returned even when no video is.

Example response

{
  "data": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "title": "Barbell Bench Press",
    "slug": "barbell-bench-press",
    "description": "A compound chest exercise performed lying on a flat bench.",
    "instructions": [
      "Lie on a flat bench with feet flat on the floor",
      "Grip the barbell slightly wider than shoulder width",
      "Lower the bar to mid-chest",
      "Press the bar back up to full arm extension"
    ],
    "importantPoints": [
      "Keep your back flat on the bench",
      "Do not bounce the bar off your chest"
    ],
    "muscleGroup": "chest",
    "secondaryMuscles": [
      "triceps",
      "shoulders"
    ],
    "muscleGroups": [
      "chest",
      "middle_chest",
      "pectoralis_major",
      "front_deltoids",
      "triceps",
      "core"
    ],
    "equipment": "barbell",
    "category": "compound",
    "difficulty": "intermediate",
    "videoUrl": "https://vz-xxx.b-cdn.net/video-id/play_720p.mp4?token=...",
    "videoHlsUrl": "https://vz-xxx.b-cdn.net/video-id/playlist.m3u8?token=...",
    "thumbnailUrl": "https://ymove.app/api/v2/thumbnail/video-id?crop=default",
    "thumbnails": {
      "default": "https://ymove.app/api/v2/thumbnail/video-id?crop=default",
      "square": "https://ymove.app/api/v2/thumbnail/video-id?crop=square",
      "portrait": "https://ymove.app/api/v2/thumbnail/video-id?crop=portrait",
      "landscape": "https://ymove.app/api/v2/thumbnail/video-id?crop=landscape",
      "original": "https://ymove.app/api/v2/thumbnail/video-id"
    },
    "videoDurationSecs": 12,
    "exerciseType": [
      "strength"
    ],
    "hasVideo": true,
    "hasVideoWhite": true,
    "hasVideoGym": false,
    "videos": [
      {
        "id": "3f6c2a9e-8b1d-4c7a-9e2f-5d0b7a1c4e88",
        "videoUrl": "https://vz-xxx.b-cdn.net/video-id/play_720p.mp4?token=...",
        "videoHlsUrl": "https://vz-xxx.b-cdn.net/video-id/playlist.m3u8?token=...",
        "thumbnailUrl": "https://ymove.app/api/v2/thumbnail/video-id?crop=default",
        "thumbnails": {
          "default": "https://ymove.app/api/v2/thumbnail/video-id?crop=default",
          "square": "https://ymove.app/api/v2/thumbnail/video-id?crop=square",
          "portrait": "https://ymove.app/api/v2/thumbnail/video-id?crop=portrait",
          "landscape": "https://ymove.app/api/v2/thumbnail/video-id?crop=landscape",
          "original": "https://ymove.app/api/v2/thumbnail/video-id"
        },
        "tag": "white-background",
        "orientation": "landscape",
        "isPrimary": true
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.