check_api_keyread-only | Confirm the configured API key works and show the plan and remaining quota. Uses one request. |
diagnose_requestread-only | Paste a failing WorkoutX request (curl, URL or "GET /v2/...") and optionally the status and response body: explains what is wrong (wrong host, key in the URL, missing header, unknown or repeated parameter, invalid value, v1 id, plan gate, rate limit, quota, expired media link) and how to fix it. Only reads the text; never sends the request. Uses one request. |
estimate_body_fatread-only | Body fat estimates from published equations using tape measurements: Relative Fat Mass (height, waist), U.S. Navy (adds neck, plus hip for women) and Deurenberg (adds weight, age). For adults and general wellness only, not medical advice. No photo needed. |
estimate_caloriesread-only | Calories burned for an exercise from its MET value, body weight and duration. |
export_exercise_seedread-only | Exercise ids, names, muscles and equipment without media, as JSON or CSV, to seed your own database or fixtures. Does not use the distinct-exercise media limit. Page with offset; plan caps per call apply (Free 10, Starter 100, others 200). |
find_exercise_alternativesread-only | Ranked swaps that train the same muscles, e.g. when equipment is missing. Optionally require or exclude equipment. |
find_similar_exercisesread-only | Exercises most similar to the given one (same pattern, muscles and equipment), ranked by score. |
generate_programread-only | A multi-week program with periodisation, deloads and weekly volume targets. Needs the Scale plan. |
generate_typesread-only | Ready-to-paste TypeScript, Swift (Codable), Kotlin (kotlinx.serialization) or Dart models for v2 responses, generated from the OpenAPI spec. Uses one request. |
generate_workoutread-only | One complete session built from movement patterns: warm-up, main work with sets/reps/rest, cool-down and swap suggestions. Needs the Growth plan or higher. |
get_body_scan_integrationread-only | How to add the WorkoutX Body Scan API to an app: endpoint, auth, fields, response shape, errors and ready-to-paste code. It returns docs only and never takes a photo: your app sends photos straight to the Body Scan API. |
get_body_scan_sample_responseread-only | A realistic sample of any Body Scan API response, so you can build and test the UI without spending scan credits. Covers success, an unreliable photo, errors and progress results. |
get_code_exampleread-only | A working snippet for a platform and task: listing and paging exercises, playing the looping MP4 and refreshing its signed link, the workout generator, error and rate-limit handling, or a backend proxy that keeps your key off the device. Uses one request. |
get_endpoint_referenceread-only | Parameters, response shape, errors and a curl example for any v2 endpoint, straight from the OpenAPI spec. Call with no endpoint to list them all. Uses one request. |
get_exerciseread-only | One exercise by v2 id: instructions, tips, muscles, equipment, sets/reps guidance, calories and signed media links. |
get_exercise_mediaread-only | Fresh signed MP4 and thumbnail links for one exercise (links expire; call again rather than storing them). |
get_supplement_stackread-only | A recommended stack for a goal with dosages and timing. Needs the Scale plan. |
get_trending_exercisesread-only | The exercises and filters (body parts, muscles, equipment, categories) requested most across WorkoutX apps in the last 30 days. Anonymised: only values at least 3 different accounts asked for, filters as shares. Good for deciding what to feature in an app. Uses one request. |
get_usage_statsread-only | Your account's API usage: requests, success rate, response times (avg and p95), errors by status code, top endpoints, daily counts, live quota, rate limit and media-limit usage. Use it to answer "why am I getting 429s?" or "when will my quota run out?". Uses one request. |
list_exercise_filtersread-only | Every valid value (with counts) for body parts, target muscles, equipment, categories and muscles. Call this before search_exercises when unsure of a value. |
map_v1_exerciseread-only | Find the v2 exercise for an old v1 id (e.g. "0025"), with the match quality: exact, equivalent, alternative, closest or none. |
search_exercisesread-only | Search 1,900+ exercises. Filters are optional and case-insensitive; combining two or more filters needs the Starter plan or higher. Results include instructions, tips, muscles, equipment, difficulty, calories and signed MP4/thumbnail links. |
search_supplementsread-only | Supplements with evidence ratings, dosage and timing. Filter by category, goal, timing, evidence or free text. Needs the Growth plan or higher. |