Food and fitness · YMove

fitness.exercises

Search YMove exercises by movement, equipment and muscle. Available demonstrations are saved to the requesting account under Resources → Workouts. Give the user each workout's URL so they can open its demonstration in Resources → Workouts. The link requires signing in to the same AI Power Ups account that requested it. Playback and video renewal do not charge user credits.

Operation: POST /v1/capabilities/fitness.exercises/execute
operationId: executeFitnessExercises
Typical credits: 10
Search deadline: 45 s server-side
Paging: page
Availability: Not checked

Cost basis: 10 credits per successful search, more or update call, including empty results; cached details, playback and shared 24-hour video renewal cost 0 credits. No plan multiplier applies. Availability is reported per deployment by GET /v1/catalog (available). The timestamped snapshot describes configuration, not provider uptime or your account's enabled choices. Check the catalog with your own key before a call. Credits are explained under credits and limits.

Request

Body of POST /v1/capabilities/fitness.exercises/execute, JSON, validated against the FitnessExercisesRequest component of the public OpenAPI document. Defaults are applied server-side, so an omitted optional field behaves exactly as its default.

Request fields of fitness.exercises
Field	Type	Required	Default	Constraints and description
query	string	no		min length 1, max length 120
equipment	string	no		min length 1, max length 120
muscle	string	no		min length 1, max length 120
num	integer	no	10	min 1, max 20

Search exercise demonstrations by words, equipment and muscle. Playable results include a private link to Resources → Workouts in the requesting account.
Unknown keys are rejected with 400 invalid_request.

Rules the schema cannot express

Checked after schema validation; violations return 400 invalid_request with a plain message.

Filters must not be blank. Each successful search, more or update costs 10 credits, including empty results. No plan multiplier applies.
Give the user each workout_resource.url. It requires the same account that requested the exercise.

Examples

Exercises

curl

curl -s -X POST https://ai-powerups.smalltree.cloud/v1/capabilities/fitness.exercises/execute \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"query":"squat","num":5}'

No recorded response is published for this capability yet. The envelope is the ExecuteResponse component (see sessions and records); the record keys below are what the adapter emits. A first call with the example above returns search_id, the records and the charge.

Result record

Every item in results[] carries record_id and title (contract, always present) and usually url and snippet. The keys below are the documented tier: produced deterministically by this capability, omitted when the source has no value, checked against recorded source fixtures in our test suite, and published as the FitnessExercisesRecord component (all optional, extra keys allowed) so generated clients type them. The wire schema itself still validates only the base keys. See stability tiers.

Record keys of fitness.exercises
Key	Type	Presence	Note
equipment	string[]	when the source has it
muscles	string[]	when the source has it
attribution	string	always
video_available	boolean	always
secondary_muscles	string[]	when the source has it	Retained wger text sessions only.
author	string	when the source has it	Retained wger text sessions only.
licence	object	when the source has it	Retained wger text sessions only.
workout_resource	object	when the source has it
video_unavailable_reason	string	when the source has it

Caveats

Saved Workouts outlive search sessions. Playback and shared video-URL renewal are free; URLs are cached across users for up to 24 hours, bounded by provider expiry.
Retained wger sessions keep their original text-only attribution and free follow-ups.

Follow-ups

Paging: Provider page number; more fetches the next page from the source. Send { "search_id": "…", "action": "more" } while has_more is true; tolerate an empty page and stop after a bounded number of pages.
Update: Re-run with changed parameters (merged into the stored query); page state resets, search_id stays. Params accept any subset of the request fields (FitnessExercisesUpdateParams).
Record actions:
- details: Exercise instructions, equipment, muscles and the private demonstration link.
Detail behaviour: Stored at search time; details is free and never calls the provider. details returns the stored exercise and owned viewing link at no charge.

record action

curl -s -X POST https://ai-powerups.smalltree.cloud/v1/follow-up \
  -H "Authorization: Bearer $AIPA_API_KEY" -H "Content-Type: application/json" \
  -d '{"record_id":"rec_…","action":"details"}'

Record detail objects of this capability are provider-shaped: documented by observation, not by schema. Full follow-up semantics: follow-up.

Typed client

With types generated from the public document (see types, client and samples) the call is path-keyed and the body is checked at compile time:

TypeScript (openapi-fetch)

const { data, error } = await client.POST("/v1/capabilities/fitness.exercises/execute", {
  body: {
    "query": "squat",
    "num": 5
  },
});
if (error) throw new Error(`${error.error.code}: ${error.error.message}`);
for (const record of data.results) console.log(record.record_id, record.title);