The official Swift package for the WorkoutX API. Build fitness apps for iOS, watchOS, iPadOS, and macOS with native async/await: API v2's 1,900+ exercises as 2,700+ 720p MP4 loops with male and female models, instructions, form tips and anatomical muscle names, plus the AI Workout Generator, supplements, and the Body Scan API. Built on URLSession, no third-party dependencies.
📦 Publishing to GitHub shortly — not yet available. Get your key now and you'll be ready the moment it lands.
Create one client with your API key and use wx.v2. The SDK sends the key in the X-WorkoutX-Key header, the only place v2 accepts it. The same client also covers the v1 resources and the Body Scan API (user JWT).
Modern concurrency built on URLSession. Strongly-typed ExerciseV2, MediaLinks and V2RankedPage models, and a flexible JSON type for workouts and supplements.
freshMedia(id) reuses the signed links from earlier calls until about 5 minutes before they expire, then fetches new ones. You store exercise ids; the SDK keeps the links valid.
Automatic retries with backoff on 429 and 5xx, honoring Retry-After. A used-up quota is not retried. Structured WorkoutXError with status, code and tips.
Every v2 exercise has media.mp4, a 600×720 loop at 30 fps (usually 100–300 KB), and media.poster, a JPEG still frame. Loop the MP4 muted with AVQueuePlayer and AVPlayerLooper. Media links are signed and expire after about 24 hours, so store exercise ids, never media URLs, and call freshMedia(id) when the view appears: it reuses the links the SDK already has and asks the API again only when they're close to expiry.
This SwiftUI view needs iOS 15+. For a loop without playback controls, attach the same player to an AVPlayerLayer in UIKit. In lists, show the poster instead of a video. On the Free plan both links are 300×360 watermarked previews (media.watermarked is true).
Downloading the files or serving them from your own servers or CDN isn't permitted on any plan. See Media in v2 for formats and limits.
Male and female versions are separate exercises. counterpartId points at the same movement with the other model, so you can offer a switch, and model filters a list to one of them. lang returns names, instructions, tips and muscles in Turkish (tr), German (de), Spanish (es), French (fr), Simplified Chinese (zh-SG) or Traditional Chinese (zh-HK). English is the default; filter values stay in English.
Similar exercises, alternatives with other equipment and calorie estimates, on v2 ids. Ranked results are full v2 exercises with media links plus a score (read exercise fields directly, e.g. r.name), and never include the exercise itself or its other-model clip. All three take lang.
v2.workout.generate() returns one session from the rule-based workout engine as the flexible JSON type: a warm-up, exercises grouped into blocks (straight sets, supersets such as C1/C2, or one circuit) with sets, reps or a duration, rest, effort (rir) and swap alternatives, then a cool-down. Every exercise in it, warm-up and cool-down items included, is a full v2 exercise with media links, and model picks the male or female clips. avoidJoints (knee, shoulder, lumbar_spine, elbow, wrist, hip, ankle) leaves out movements that load those joints heavily; it is general guidance, not medical advice. format picks straight, superset or circuit (default auto). The response also carries estimatedDurationMinutes and the seed it used. v2.workout.program() returns a schedule, the week-by-week program and an exerciseLibrary that its exercises reference by exerciseId. The generator needs Growth or Scale (legacy Pro, Ultra); multi-week programs need Scale (legacy Ultra).
The evidence-graded supplement database in the v2 page shape, { total, limit, offset, results, disclaimer }, as JSON. Growth and Scale (legacy Pro, Ultra); stacks need Scale (legacy Ultra). Informational content only, not medical advice. Supplement text is English.
Narrow v2.list() by the joint a movement works through, an intensity band and descriptive tags, for physical therapy, mobility and senior-fitness apps. Growth and Scale (legacy Ultra). These are descriptive fields, not medical recommendations.
v1 keeps working on the same key, and you'll get at least 30 days' notice before it's retired. The SDK's v1 resources (exercises, gifs, workout, supplements) are unchanged, so you can move one screen at a time. Map each v1 id you've stored once with v2.legacy() and save the v2 id: 1,324 of the 1,327 v1 exercises have a v2 match.
Step by step, with code for each platform: the v2 migration guide.
Every non-2xx response throws a WorkoutXError with status, code, message, tip and the raw body. A feature your plan doesn't include answers 403 and names the plan that has it. A 429 is either a rate limit, which the SDK retries with backoff, or a used-up request quota, which it doesn't retry. The Free plan's 500 requests are a one-time allowance.
Add the Swift Package https://github.com/furkanuruk/workoutx-sdk-swift in Xcode (File ▸ Add Package Dependencies) or to your Package.swift dependencies, then add the WorkoutX product to your target. API v2 lives under wx.v2.
iOS 13+, macOS 10.15+, watchOS 6+, and tvOS 13+. It uses native async/await and URLSession, with no third-party dependencies. The SwiftUI player example on this page needs iOS 15+.
Get links with wx.v2.freshMedia(id), then loop media.mp4 muted with AVQueuePlayer and AVPlayerLooper in a VideoPlayer or an AVPlayerLayer. Use AsyncImage with media.poster in lists.
No. Media links are signed and expire after about 24 hours. Store exercise ids and call freshMedia(id) when you show an exercise; it reuses links until they're close to expiry. Downloading or self-hosting the files isn't allowed on any plan.
Yes. wx.exercises, wx.gifs, wx.workout and wx.supplements still call v1, which keeps working; you'll get at least 30 days' notice before it's retired. wx.v2.legacy(v1Id) maps the v1 ids you've stored to v2.
Body Scan uses a logged-in user's JWT. Pass scan: .token("..."), or scan: .credentials(email:password:) to let the SDK log in automatically.
Anything bundled in an iOS app can be extracted. For production, route requests through your own backend, or ship a separate key for the app that you can rotate from the dashboard rather than your main key. v2 accepts the key only in the X-WorkoutX-Key header, which the SDK sets for you.
media.mp4 and media.poster are signed links that expire after about 24 hours. They contain no API key, so AVPlayer and AsyncImage can load them directly. Store exercise ids, not links. (v1's gifURL() still puts the key in the URL.)
For Body Scan, fetch a short-lived JWT from your backend and pass scan: .token(...). Avoid shipping the email/password login flow inside the app.
Start free with 500 requests and watermarked previews. 1,900+ exercises as 720p video, workouts, and Body Scan in one Swift package.
Get your free API key