> ## Documentation Index > Fetch the complete documentation index at: https://docs.fitsociety.io/llms.txt > Use this file to discover all available pages before exploring further. # Create a workout exercise as a client > Videos share the company video-library storage allowance (25 decimal GB by default, admin adjustable). Coach web clients should use the exercise video-uploads presign/complete/status flow and send ready video URLs. Existing native multipart video uploads remain supported up to 100 MiB per file; these reserve the same quota and wait for the same compression worker. Client-facing counterpart of `POST /app/v1/workout/exercises` — lets a client create their own exercise (stored under the client's active company scope with `addedByRole: Client`). Requires a **client** token. Accepts either `application/json` or `multipart/form-data`; in multipart requests, send structured arrays/objects as JSON strings, use `imageFiles` and `videoFiles` for uploads (the legacy binary aliases `images` and `videos` are still accepted). Any `visibility` in the body is ignored — client-created exercises are always forced to `visibility=Company` by the controller. Requires the `workout_client_plans:write` scope and the corresponding Workout features and permissions. The clientId path parameter identifies a client in the company bound to the Public API token. ## OpenAPI ````yaml /openapi/public-v1.json post /public/v1/workout/clients/{clientId}/exercises openapi: 3.1.0 info: title: FITsociety Public API v1 version: 1.0.0 description: >- Developer Public API endpoints under `/public/v1`. This reference is filtered to OAuth/Bearer Public API resources and excludes provider callback receivers, storefront routes, public widgets, wishlist routes, and access-device validation endpoints. contact: name: FITsociety Engineering servers: - url: https://api.fitsociety.io description: Production security: [] tags: - name: Health description: Public API token health checks. - name: OAuth description: Public API OAuth endpoints for server-to-server client credentials. - name: Platform description: >- Inspect Public API client context, capabilities, scopes, and redacted audit logs. - name: Company Catalog description: Read and manage company profile metadata and locations. - name: Clients description: >- Create and manage clients through the Public API using Bearer access tokens. - name: Coaches description: Retrieve coaches for the authenticated company via integrations. - name: Calendar Events description: Read Public API calendar events. - name: Calendar Templates description: >- Read and manage event types and event templates used by calendar availability and bookings. - name: Calendar Extensions description: >- Read recurring bookings, booking requests, calendar tasks, and availability closure metadata. - name: Availability description: Read bookable availability slots and signed availability tokens. - name: Availability Management description: >- Manage coach and location availability templates used to derive bookable slots. - name: Bookings description: Read and manage Public API bookings. - name: Finance description: >- Read invoices, transactions, products, subscriptions, and memberships with guarded finance writes. - name: Credits description: >- Read company-wide and client-scoped credit allocations, mutations, and guarded credit adjustments. - name: Exports description: >- Create and monitor asynchronous company exports through Public API Bearer endpoints. - name: Webhooks description: >- Manage outbound webhook subscriptions and inspect delivery attempts through Public API Bearer endpoints. - name: Measurements description: Read and write client measurement entries. - name: Progress Photos description: Read client progress photo metadata and short-lived signed media URLs. - name: Forms description: Read, create, update, and archive company form templates. - name: Intakes description: Assign intake forms and read client intake assignments and submissions. - name: Check-ups description: >- Schedule and cancel client check-ups and read their status and submissions. - name: Documents description: >- Read client document and folder metadata, register external document links, update metadata, and archive documents from Public API listings. Binary upload, permanent deletion, and company-wide document management are not exposed. - name: Habits description: Read habits and habit entries. - name: Goals description: Read client goal summaries. - name: Conversations description: >- Read and manage direct and group chat conversations through the Public API. - name: Reports description: Read aggregate attendance, revenue, and retention summaries. - name: Workout description: >- Workout libraries, programmes, client plans, calendars, sessions, groups, settings and progress. AI operations are excluded. paths: /public/v1/workout/clients/{clientId}/exercises: post: tags: - Workout summary: Create a workout exercise as a client description: >- Videos share the company video-library storage allowance (25 decimal GB by default, admin adjustable). Coach web clients should use the exercise video-uploads presign/complete/status flow and send ready video URLs. Existing native multipart video uploads remain supported up to 100 MiB per file; these reserve the same quota and wait for the same compression worker. Client-facing counterpart of `POST /app/v1/workout/exercises` — lets a client create their own exercise (stored under the client's active company scope with `addedByRole: Client`). Requires a **client** token. Accepts either `application/json` or `multipart/form-data`; in multipart requests, send structured arrays/objects as JSON strings, use `imageFiles` and `videoFiles` for uploads (the legacy binary aliases `images` and `videos` are still accepted). Any `visibility` in the body is ignored — client-created exercises are always forced to `visibility=Company` by the controller. Requires the `workout_client_plans:write` scope and the corresponding Workout features and permissions. The clientId path parameter identifies a client in the company bound to the Public API token. operationId: publicWorkoutpostPublicV1WorkoutClientsClientIdExercises parameters: - name: Idempotency-Key in: header required: true schema: type: string minLength: 1 maxLength: 200 example: booking-create-20260714-001 description: >- Required for Public API write requests. Reusing the same key with the same method, path, and body replays the stored successful response; reusing it with a different request returns `409 idempotency.conflict`. - name: clientId in: path required: true schema: type: string pattern: ^[a-fA-F0-9]{24}$ description: Client in the company bound to the Public API token. requestBody: required: true content: application/json: schema: $ref: >- #/components/schemas/PublicWorkoutSourcePOSTAppV1WorkoutExercisesClientCreateRequest multipart/form-data: schema: type: object required: - name - description - primaryCategory - primaryMuscle properties: name: type: string description: Multipart JSON string for `WorkoutLocalizedTextArray`. example: >- [{"lang":"en","value":"Barbell Bench Press"},{"lang":"nl","value":"Barbell Bench Press"}] description: type: string description: Multipart JSON string for `WorkoutLocalizedTextArray`. example: >- [{"lang":"en","value":"Flat horizontal press."},{"lang":"nl","value":"Vlakke horizontale press."}] primaryCategory: type: string enum: - Agility & Speed - Strength - Hypertrophy - Strength - Dynamic - Strength - Explosive - Strength - Static - Cardio - Cardio - Duration - Cardio - Interval - HIIT - Crossfit - Mobility - Stretching - Core - Coordination & Balance - Movement Prep - Functional Training - Recovery - Sports - Martial Arts - Yoga - Other - GROUP_WORKOUT_TEMPLATE - Plyometric - Cycling - Cardio - interval - Mobilisation - Stabilisation - Daily Living - Target zone - Respiration - Breathing - Massage - Outdoor sports - Indoor sports - Dance - Group Lessons - Martial arts - Material Arts - Fight skills - Mind and body - '' - default example: Strength secondaryCategories: type: string description: Multipart JSON string for `string[]`. example: '["General Fitness"]' primaryMuscle: type: string enum: - Chest - Back - Lats - Traps - Shoulders - Biceps - Triceps - Forearms - Core - Abs - Obliques - Glutes - Quads - Hamstrings - Calves - Adductors - Abductors - Hip Flexors - Full Body - Cardio / Conditioning - Neck - Lower Back example: Chest secondaryMuscles: type: string description: Multipart JSON string for `string[]`. example: '["Shoulders","Triceps"]' primaryJoint: type: string enum: - '' - Ankle - Combination - Core - Elbow - Fingers - Hip - Knee - Neck - Shoulder - Spine - Wrist example: Shoulder equipment: type: string description: Multipart JSON string for `string[]`. example: '["Barbell","Bench"]' met: type: string description: >- Multipart scalar value. Send numeric values as JSON-compatible strings. example: '6' calories: type: string description: Multipart JSON string for `WorkoutExerciseCalories`. example: '{"estimate":125,"unit":"kcal","method":"formula"}' images: type: string description: >- Multipart JSON string for `WorkoutImageAsset[]`. Combine with uploaded `imageFiles` when you want to attach uploaded media. example: >- [{"url":"https://cdn.example.com/workouts/bench-1.jpg","width":1280,"height":720}] videos: type: string description: >- Multipart JSON string for `WorkoutVideoAsset[]`. Combine with uploaded `videoFiles` when you want to attach uploaded media. example: >- [{"url":"https://cdn.example.com/workouts/bench-demo.mp4","platform":"s3","videoId":"","thumbnail":"https://cdn.example.com/workouts/bench-demo-thumb.jpg","duration":84,"width":1920,"height":1080}] difficulty: type: string enum: - '' - Beginner - Intermediate - Advanced example: Intermediate intensity: type: string enum: - '' - Beginner - Below Average - Average - Above Average - High Intensity example: Above Average tags: type: string description: Multipart JSON string for `string[]`. example: '["compound","push"]' visibility: type: string enum: - Everyone - Company - Fitsociety example: Company imageFiles: type: array items: type: string format: binary maxItems: 5 description: >- Preferred binary fields are `imageFiles` and `videoFiles`. Legacy binary aliases `images` and `videos` remain accepted by the backend for backward compatibility. Structured array/object fields must be sent as JSON strings. Max 5 image files. videoFiles: type: array items: type: string format: binary maxItems: 3 description: >- Preferred binary fields are `imageFiles` and `videoFiles`. Legacy binary aliases `images` and `videos` remain accepted by the backend for backward compatibility. Structured array/object fields must be sent as JSON strings. Max 3 video files. responses: '200': description: Exercise created. Returns its exerciseId and stored exercise. content: application/json: schema: allOf: - $ref: '#/components/schemas/PublicApiWriteSuccessResponse' - type: object properties: data: $ref: >- #/components/schemas/PublicWorkoutSourcePOSTAppV1WorkoutExercisesClientCreateResponse200 examples: success: summary: Successful response value: data: _id: 67f1234567890abcdef1234 exerciseId: 67f1234567890abcdef1234 exercise: name: Barbell Bench Press description: Flat horizontal press. primaryCategory: Strength secondaryCategories: - Agility & Speed primaryMuscle: Chest secondaryMuscles: - Chest primaryJoint: Shoulder equipment: - Dumbbells popularity: 82 difficulty: Intermediate intensity: Above Average visibility: Everyone createdAt: '2026-04-12T10:00:00.000Z' images: - url: https://cdn.example.com/workouts/plan-cover.jpg width: 1280 height: 720 videos: - url: https://cdn.example.com/workouts/demo.mp4 platform: s3 videoId: '' thumbnail: https://cdn.example.com/workouts/demo-thumb.jpg duration: 84 width: 1920 height: 1080 muscleActivation: raw: chest: 18 shoulders: 12 triceps: 8 normalized: chest: 18 shoulders: 12 triceps: 8 maxValue: 18 topMuscles: - muscle: chest value: 18 externalReference: externalId: 66f7b8b1e13c8d25f4d3d90a revision: 1 meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 idempotency: replayed: false '400': description: >- Validation error. Typical message keys: `FIELD_REQUIRED`, `FIELDS_REQUIRED`, `COMPANYID_REQUIRED`, `INVALID_EXERCISE_*` and `EXERCISE_*` payload validation keys. content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: invalidRequest: summary: Invalid request value: error: code: 400 key: request.invalid message: The request is invalid. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 idempotencyRequired: summary: Missing Idempotency-Key value: error: code: 400 key: idempotency.required message: >- Idempotency-Key header is required for Public API write requests. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 idempotencyInvalid: summary: Invalid Idempotency-Key value: error: code: 400 key: idempotency.invalid message: Idempotency-Key header must be 200 characters or fewer. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '401': $ref: '#/components/schemas/ErrorResponse' content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: missingBearer: summary: Missing Bearer token value: error: code: 401 key: auth.missing_bearer message: Authorization Bearer token is required. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 invalidToken: summary: Invalid or expired token value: error: code: 401 key: auth.invalid_token message: The access token is invalid or expired. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 invalidClient: summary: Inactive or revoked client value: error: code: 401 key: auth.invalid_client message: The Public API client is inactive or revoked. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '403': $ref: '#/components/schemas/ErrorResponse' content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: insufficientScopes: summary: Missing required scope value: error: code: 403 key: scopes.insufficient message: The access token does not include the required scope. details: requiredScopes: - workout_client_plans:write meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '404': $ref: '#/components/schemas/ErrorResponse' content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: notFound: summary: Resource not found value: error: code: 404 key: resource.not_found message: The requested Public API resource was not found. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '409': description: VIDEO_STORAGE_LIMIT_EXCEEDED or VIDEO_STORAGE_BUSY. content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: idempotencyConflict: summary: Idempotency-Key conflict value: error: code: 409 key: idempotency.conflict message: >- Idempotency-Key was already used with a different request. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 idempotencyInProgress: summary: Idempotency-Key in progress value: error: code: 409 key: idempotency.in_progress message: >- Idempotency-Key is already processing for this Public API client. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '413': description: One or more uploaded files exceeded the allowed size. content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: serverInternalError: summary: Unexpected server error value: error: code: 413 key: server.internal_error message: An unexpected Public API server error occurred. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '422': $ref: '#/components/schemas/ErrorResponse' content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: emptyBody: summary: Empty or invalid JSON object body value: error: code: 422 key: EMPTY_BODY message: Request body must be a non-empty JSON object. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 '429': $ref: '#/components/schemas/ErrorResponse' content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: rateLimitExceeded: summary: Rate limit exceeded value: error: code: 429 key: rate_limit.exceeded message: Too many Public API requests. Retry later. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 0 resetSeconds: 1 retryAfterSeconds: 1 '500': description: Unexpected server error. content: application/json: schema: $ref: '#/components/schemas/PublicApiError' examples: serverInternalError: summary: Unexpected server error value: error: code: 500 key: server.internal_error message: An unexpected Public API server error occurred. meta: requestId: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: limit: 10 remaining: 9 resetSeconds: 1 security: - PublicBearerAuth: [] x-codeSamples: - lang: cURL label: cURL source: >- curl -X POST 'https://api.fitsociety.io/public/v1/workout/clients/66f7b8b1e13c8d25f4d3d90c/exercises' \ -H 'Authorization: Bearer ' \ -H 'Idempotency-Key: public-v1-workout-clients-clientId-exercises-001' \ -H 'Content-Type: application/json' \ -d '{"name":[{"lang":"en","value":"Barbell Bench Press"}],"description":[{"lang":"en","value":"Flat horizontal press."}],"primaryCategory":"Strength","primaryMuscle":"Chest","visibility":"Company"}' components: schemas: PublicWorkoutSourcePOSTAppV1WorkoutExercisesClientCreateRequest: type: object required: - name - description - primaryCategory - primaryMuscle properties: name: type: array minItems: 1 items: type: object required: - lang - value properties: lang: type: string enum: - en - nl - fr - de - es example: en value: type: string example: Full Body Strength example: - lang: en value: Full Body Strength - lang: nl value: Full Body Kracht description: type: array minItems: 1 items: type: object required: - lang - value properties: lang: type: string enum: - en - nl - fr - de - es example: en value: type: string example: Full Body Strength example: - lang: en value: Full Body Strength - lang: nl value: Full Body Kracht primaryCategory: type: string enum: - Agility & Speed - Strength - Hypertrophy - Strength - Dynamic - Strength - Explosive - Strength - Static - Cardio - Cardio - Duration - Cardio - Interval - HIIT - Crossfit - Mobility - Stretching - Core - Coordination & Balance - Movement Prep - Functional Training - Recovery - Sports - Martial Arts - Yoga - Other - GROUP_WORKOUT_TEMPLATE - Plyometric - Cycling - Cardio - interval - Mobilisation - Stabilisation - Daily Living - Target zone - Respiration - Breathing - Massage - Outdoor sports - Indoor sports - Dance - Group Lessons - Martial arts - Material Arts - Fight skills - Mind and body - '' - default example: Strength secondaryCategories: type: array items: type: string enum: - Agility & Speed - Strength - Hypertrophy - Strength - Dynamic - Strength - Explosive - Strength - Static - Cardio - Cardio - Duration - Cardio - Interval - HIIT - Crossfit - Mobility - Stretching - Core - Coordination & Balance - Movement Prep - Functional Training - Recovery - Sports - Martial Arts - Yoga - Other - GROUP_WORKOUT_TEMPLATE - Plyometric - Cycling - Cardio - interval - Mobilisation - Stabilisation - Daily Living - Target zone - Respiration - Breathing - Massage - Outdoor sports - Indoor sports - Dance - Group Lessons - Martial arts - Material Arts - Fight skills - Mind and body - '' - default example: - General Fitness primaryMuscle: type: string enum: - Chest - Back - Lats - Traps - Shoulders - Biceps - Triceps - Forearms - Core - Abs - Obliques - Glutes - Quads - Hamstrings - Calves - Adductors - Abductors - Hip Flexors - Full Body - Cardio / Conditioning - Neck - Lower Back example: Chest secondaryMuscles: type: array items: type: string enum: - Chest - Back - Lats - Traps - Shoulders - Biceps - Triceps - Forearms - Core - Abs - Obliques - Glutes - Quads - Hamstrings - Calves - Adductors - Abductors - Hip Flexors - Full Body - Cardio / Conditioning - Neck - Lower Back example: - Shoulders - Triceps primaryJoint: type: string enum: - '' - Ankle - Combination - Core - Elbow - Fingers - Hip - Knee - Neck - Shoulder - Spine - Wrist example: Shoulder equipment: type: array items: type: string enum: - Dumbbells - AdjustableDumbbells - Kettlebell - AdjustableKettlebell - CompetitionKettlebell - Medicineball - SlamBall - WallBall - Weightplate - BumperPlates - FractionalPlates - LoadableDumbbellHandle - Sandbag - StrongmanSandbag - Bulgarianbag - Aquabag - Aquaball - Hydrovest - MagneticBell - Macebell - SteelClub - IndianClub - Barbell - OlympicBarbell - TechniqueBar - EZBar - TrapBar - SafetySquatBar - SwissBar - CamberedBar - AxleBar - Landmine - Bench - FlatBench - AdjustableBench - InclineBench - DeclineBench - SealRowBench - HipThrustBench - BenchPressRack - SquatRack - SquatStand - PowerRack - WallMountedRack - HalfRack - SmithMachine - Monolift - JammerArms - BarbellJack - WeightTree - PlateStorage - DeadliftPlatform - Rig - StrengthMachinesPlateloaded - StrengthMachinesWeightstack - StrengthMachinesPneumatic - MultiGym - LegPressMachine - VerticalLegPressMachine - LeverageSquatMachine - LinearHackSquatMachine - BeltSquatMachine - PendulumSquatMachine - VSquatMachine - HackSquatMachine - LegExtensionMachine - LegCurlMachine - SeatedLegCurlMachine - LyingLegCurlMachine - StandingLegCurlMachine - StandingCalfRaiseMachine - SeatedCalfRaiseMachine - CalfPressMachine - HipThrustMachine - GluteDriveMachine - GluteKickbackMachine - HipExtensionMachine - HipAbductionMachine - HipAdductionMachine - ChestPressMachine - VerticalChestPressMachine - InclineChestPressMachine - DeclineChestPressMachine - IsoLateralChestPressMachine - IsoLateralInclinePressMachine - ShoulderPressMachine - IsoLateralShoulderPressMachine - MultiPressMachine - LateralRaiseMachine - RearDeltMachine - PecDeckMachine - PulloverMachine - LatPulldownMachine - IsoLateralLatPulldownMachine - AssistedPullupMachine - AssistedDipMachine - SeatedDipMachine - SeatedRowMachine - LowRowMachine - HighRowMachine - IsoLateralRowMachine - ChestSupportedRowMachine - TBarRowMachine - BicepsCurlMachine - PreacherCurlMachine - TricepsExtensionMachine - AbCrunchMachine - AbCoasterMachine - RotaryTorsoMachine - BackExtensionMachine - SeatedBackExtensionMachine - HyperextensionBench - ReverseHyper - GHD - Kinesis - Pulley - CableMachine - CableStation - CableColumn - CableCrossover - DualAdjustablePulley - SingleCableTower - FunctionalTrainer - TotalGymGTS - Gymstick - ViPR - RipTrainer - Battlerope - ProwlerSled - FarmersHandles - Yoke - Tire - Sledgehammer - TorqueTank - SledTrack - WallBallTarget - AgilityPoles - MiniHurdles - SprintParachute - PullUpBar - Parallelbars - DipBars - Equalizer - Suspensiontrainer - SuspensionSlingTrainer - GymnasticRings - MonkeyBars - PegBoard - RopeClimb - Wall - StallBars - DoorPullUpBar - PushUpHandles - AbStraps - Boxstep - SoftPlyoBox - Hurdle - Speedladder - Parallettes - NordicBench - SissySquatBench - Cardio - Treadmill - CurvedTreadmill - AirRunner - AssaultRunner - StationaryBike - UprightBike - RecumbentBike - BikeErg - SpinBike - AirBike - Rower - WaterRower - FanRower - ArmErgometer - SkiErg - Elliptical - ArcTrainer - NuStep - StairClimber - StepMill - JacobsLadder - VersaClimber - Bosu - Balanceball - Exerciseball - PilatesTennisball - PilatesRing - YogaMat - YogaBlock - YogaWheel - StretchStrap - MobilityStick - MassageBall - PeanutMassageBall - Airpad - Balanceboard - BalancePad - WobbleBoard - Glidedisc - Foamroller - Elasticbands - TherapyBand - Resistanceband - MiniBand - PullUpAssistBand - Powertube - AnkleWeights - SlantBoard - Vibrationtraining - CableRope - StraightBarAttachment - CurlBarAttachment - LatBarAttachment - TricepsBarAttachment - RowHandle - DHandle - DoubleDHandle - AnkleCuff - CableCuff - LandmineHandle - MagGripAttachment - DipBelt - AbWheel - WristRoller - FatGrip - Chain - DoorAnchor - JumpRope - SpeedRope - WeightedJumpRope - SledHarness - LiftingStraps - LiftingHooks - WristWraps - WeightliftingBelt - Clubbel - Stick - Bodybow - BuddySystem - Multinet - Flowin - Aerialhoop - Dancingpole - Trapeze - HulaHoop - Trampoline - XCO - PilatesReformer - PilatesChair - PilatesCadillac - PilatesBarrel - PilatesSpringboard - BalanceBeam - TreatmentTable - RehabTable - SlideBoard example: - Barbell - Bench met: type: - number - 'null' example: 6 calories: type: object properties: estimate: type: - number - 'null' example: 125 unit: type: string example: kcal method: type: string example: formula images: type: array items: type: object required: - url properties: url: type: string format: uri example: https://cdn.example.com/workouts/plan-cover.jpg width: type: - number - 'null' example: 1280 height: type: - number - 'null' example: 720 videos: type: array items: type: object required: - url - platform properties: url: type: string format: uri example: https://cdn.example.com/workouts/demo.mp4 platform: type: string enum: - s3 - youtube - tiktok example: s3 videoId: type: string example: '' thumbnail: type: string format: uri example: https://cdn.example.com/workouts/demo-thumb.jpg duration: type: - number - 'null' example: 84 width: type: - number - 'null' example: 1920 height: type: - number - 'null' example: 1080 difficulty: type: string enum: - '' - Beginner - Intermediate - Advanced example: Intermediate intensity: type: string enum: - '' - Beginner - Below Average - Average - Above Average - High Intensity example: Above Average tags: type: array items: type: string example: - compound - push visibility: type: string enum: - Everyone - Company - Fitsociety example: Company defaultType: type: string enum: - '' - reps - time - distance - bodyweight - weighted_bodyweight - assisted_bodyweight description: Optional fallback tracking type for freestyle sessions. example: reps externalReference: type: string minLength: 1 maxLength: 200 pattern: ^[^\u0000-\u001F\u007F]+$ description: >- Optional opaque resource reference owned by the authenticated API client and company. Available only for application/json creation without file uploads. Trimmed, nonempty and at most 200 characters; control characters are rejected. Repeating the reference with the same creation content returns the existing resource; conflicting content returns 409. example: programme-v1 PublicApiWriteSuccessResponse: type: object additionalProperties: false required: - data - meta properties: data: type: object meta: $ref: '#/components/schemas/PublicApiWriteMeta' PublicWorkoutSourcePOSTAppV1WorkoutExercisesClientCreateResponse200: type: object required: - _id - exerciseId properties: _id: type: string example: 67f1234567890abcdef1234 exerciseId: type: string example: 67f1234567890abcdef1234 exercise: type: object properties: name: type: string example: Barbell Bench Press description: type: string example: Flat horizontal press. primaryCategory: type: string enum: - Agility & Speed - Strength - Hypertrophy - Strength - Dynamic - Strength - Explosive - Strength - Static - Cardio - Cardio - Duration - Cardio - Interval - HIIT - Crossfit - Mobility - Stretching - Core - Coordination & Balance - Movement Prep - Functional Training - Recovery - Sports - Martial Arts - Yoga - Other - GROUP_WORKOUT_TEMPLATE - Plyometric - Cycling - Cardio - interval - Mobilisation - Stabilisation - Daily Living - Target zone - Respiration - Breathing - Massage - Outdoor sports - Indoor sports - Dance - Group Lessons - Martial arts - Material Arts - Fight skills - Mind and body - '' - default example: Strength secondaryCategories: type: array items: type: string enum: - Agility & Speed - Strength - Hypertrophy - Strength - Dynamic - Strength - Explosive - Strength - Static - Cardio - Cardio - Duration - Cardio - Interval - HIIT - Crossfit - Mobility - Stretching - Core - Coordination & Balance - Movement Prep - Functional Training - Recovery - Sports - Martial Arts - Yoga - Other - GROUP_WORKOUT_TEMPLATE - Plyometric - Cycling - Cardio - interval - Mobilisation - Stabilisation - Daily Living - Target zone - Respiration - Breathing - Massage - Outdoor sports - Indoor sports - Dance - Group Lessons - Martial arts - Material Arts - Fight skills - Mind and body - '' - default primaryMuscle: type: string enum: - Chest - Back - Lats - Traps - Shoulders - Biceps - Triceps - Forearms - Core - Abs - Obliques - Glutes - Quads - Hamstrings - Calves - Adductors - Abductors - Hip Flexors - Full Body - Cardio / Conditioning - Neck - Lower Back example: Chest secondaryMuscles: type: array items: type: string enum: - Chest - Back - Lats - Traps - Shoulders - Biceps - Triceps - Forearms - Core - Abs - Obliques - Glutes - Quads - Hamstrings - Calves - Adductors - Abductors - Hip Flexors - Full Body - Cardio / Conditioning - Neck - Lower Back primaryJoint: type: string enum: - '' - Ankle - Combination - Core - Elbow - Fingers - Hip - Knee - Neck - Shoulder - Spine - Wrist example: Shoulder equipment: type: array items: type: string enum: - Dumbbells - AdjustableDumbbells - Kettlebell - AdjustableKettlebell - CompetitionKettlebell - Medicineball - SlamBall - WallBall - Weightplate - BumperPlates - FractionalPlates - LoadableDumbbellHandle - Sandbag - StrongmanSandbag - Bulgarianbag - Aquabag - Aquaball - Hydrovest - MagneticBell - Macebell - SteelClub - IndianClub - Barbell - OlympicBarbell - TechniqueBar - EZBar - TrapBar - SafetySquatBar - SwissBar - CamberedBar - AxleBar - Landmine - Bench - FlatBench - AdjustableBench - InclineBench - DeclineBench - SealRowBench - HipThrustBench - BenchPressRack - SquatRack - SquatStand - PowerRack - WallMountedRack - HalfRack - SmithMachine - Monolift - JammerArms - BarbellJack - WeightTree - PlateStorage - DeadliftPlatform - Rig - StrengthMachinesPlateloaded - StrengthMachinesWeightstack - StrengthMachinesPneumatic - MultiGym - LegPressMachine - VerticalLegPressMachine - LeverageSquatMachine - LinearHackSquatMachine - BeltSquatMachine - PendulumSquatMachine - VSquatMachine - HackSquatMachine - LegExtensionMachine - LegCurlMachine - SeatedLegCurlMachine - LyingLegCurlMachine - StandingLegCurlMachine - StandingCalfRaiseMachine - SeatedCalfRaiseMachine - CalfPressMachine - HipThrustMachine - GluteDriveMachine - GluteKickbackMachine - HipExtensionMachine - HipAbductionMachine - HipAdductionMachine - ChestPressMachine - VerticalChestPressMachine - InclineChestPressMachine - DeclineChestPressMachine - IsoLateralChestPressMachine - IsoLateralInclinePressMachine - ShoulderPressMachine - IsoLateralShoulderPressMachine - MultiPressMachine - LateralRaiseMachine - RearDeltMachine - PecDeckMachine - PulloverMachine - LatPulldownMachine - IsoLateralLatPulldownMachine - AssistedPullupMachine - AssistedDipMachine - SeatedDipMachine - SeatedRowMachine - LowRowMachine - HighRowMachine - IsoLateralRowMachine - ChestSupportedRowMachine - TBarRowMachine - BicepsCurlMachine - PreacherCurlMachine - TricepsExtensionMachine - AbCrunchMachine - AbCoasterMachine - RotaryTorsoMachine - BackExtensionMachine - SeatedBackExtensionMachine - HyperextensionBench - ReverseHyper - GHD - Kinesis - Pulley - CableMachine - CableStation - CableColumn - CableCrossover - DualAdjustablePulley - SingleCableTower - FunctionalTrainer - TotalGymGTS - Gymstick - ViPR - RipTrainer - Battlerope - ProwlerSled - FarmersHandles - Yoke - Tire - Sledgehammer - TorqueTank - SledTrack - WallBallTarget - AgilityPoles - MiniHurdles - SprintParachute - PullUpBar - Parallelbars - DipBars - Equalizer - Suspensiontrainer - SuspensionSlingTrainer - GymnasticRings - MonkeyBars - PegBoard - RopeClimb - Wall - StallBars - DoorPullUpBar - PushUpHandles - AbStraps - Boxstep - SoftPlyoBox - Hurdle - Speedladder - Parallettes - NordicBench - SissySquatBench - Cardio - Treadmill - CurvedTreadmill - AirRunner - AssaultRunner - StationaryBike - UprightBike - RecumbentBike - BikeErg - SpinBike - AirBike - Rower - WaterRower - FanRower - ArmErgometer - SkiErg - Elliptical - ArcTrainer - NuStep - StairClimber - StepMill - JacobsLadder - VersaClimber - Bosu - Balanceball - Exerciseball - PilatesTennisball - PilatesRing - YogaMat - YogaBlock - YogaWheel - StretchStrap - MobilityStick - MassageBall - PeanutMassageBall - Airpad - Balanceboard - BalancePad - WobbleBoard - Glidedisc - Foamroller - Elasticbands - TherapyBand - Resistanceband - MiniBand - PullUpAssistBand - Powertube - AnkleWeights - SlantBoard - Vibrationtraining - CableRope - StraightBarAttachment - CurlBarAttachment - LatBarAttachment - TricepsBarAttachment - RowHandle - DHandle - DoubleDHandle - AnkleCuff - CableCuff - LandmineHandle - MagGripAttachment - DipBelt - AbWheel - WristRoller - FatGrip - Chain - DoorAnchor - JumpRope - SpeedRope - WeightedJumpRope - SledHarness - LiftingStraps - LiftingHooks - WristWraps - WeightliftingBelt - Clubbel - Stick - Bodybow - BuddySystem - Multinet - Flowin - Aerialhoop - Dancingpole - Trapeze - HulaHoop - Trampoline - XCO - PilatesReformer - PilatesChair - PilatesCadillac - PilatesBarrel - PilatesSpringboard - BalanceBeam - TreatmentTable - RehabTable - SlideBoard popularity: type: number example: 82 difficulty: type: string enum: - '' - Beginner - Intermediate - Advanced example: Intermediate intensity: type: string enum: - '' - Beginner - Below Average - Average - Above Average - High Intensity example: Above Average visibility: type: string enum: - Everyone - Company - Fitsociety example: Everyone createdAt: type: string format: date-time example: '2026-04-12T10:00:00.000Z' images: type: array items: type: object required: - url properties: url: type: string format: uri example: https://cdn.example.com/workouts/plan-cover.jpg width: type: - number - 'null' example: 1280 height: type: - number - 'null' example: 720 videos: type: array items: type: object required: - url - platform properties: url: type: string format: uri example: https://cdn.example.com/workouts/demo.mp4 platform: type: string enum: - s3 - youtube - tiktok example: s3 videoId: type: string example: '' thumbnail: type: string format: uri example: https://cdn.example.com/workouts/demo-thumb.jpg duration: type: - number - 'null' example: 84 width: type: - number - 'null' example: 1920 height: type: - number - 'null' example: 1080 muscleActivation: type: object properties: raw: type: object additionalProperties: type: number example: chest: 18 shoulders: 12 triceps: 8 normalized: type: object additionalProperties: type: number example: chest: 18 shoulders: 12 triceps: 8 maxValue: type: number example: 18 topMuscles: type: array items: type: object required: - muscle - value properties: muscle: type: string example: chest value: type: number example: 18 externalReference: $ref: '#/components/schemas/PublicWorkoutExternalReferenceReceipt' PublicApiError: type: object additionalProperties: false required: - error - meta properties: error: type: object additionalProperties: false required: - code - key - message properties: code: type: integer example: 401 key: type: string example: auth.invalid_token message: type: string example: The access token is invalid. details: type: object additionalProperties: true meta: $ref: '#/components/schemas/PublicApiMeta' ErrorResponse: allOf: - $ref: '#/components/schemas/StandardResponse' - example: status: 401 error: true message: MISSING_AUTH PublicApiWriteMeta: type: object additionalProperties: false required: - requestId properties: requestId: type: string description: Stable request correlation id. Mirrors `X-Request-Id` when supplied. example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: $ref: '#/components/schemas/PublicApiRateLimitMeta' idempotency: type: object additionalProperties: false properties: replayed: type: boolean description: >- True when the response was replayed from a previous request with the same `Idempotency-Key`. example: true PublicWorkoutExternalReferenceReceipt: type: object required: - externalId - revision properties: externalId: type: string minLength: 1 maxLength: 200 revision: type: integer enum: - 1 additionalProperties: false PublicApiMeta: type: object additionalProperties: false required: - requestId properties: requestId: type: string description: Stable request correlation id. Mirrors `X-Request-Id` when supplied. example: 4f849d7d-f4f1-45cc-b4b7-3984a3d17f83 rateLimit: $ref: '#/components/schemas/PublicApiRateLimitMeta' StandardResponse: type: object properties: status: type: integer example: 200 error: type: boolean example: false message: type: string example: SUCCESS required: - status - error - message PublicApiRateLimitMeta: type: object additionalProperties: false properties: limit: type: integer example: 10 remaining: type: integer example: 9 resetSeconds: type: integer description: Seconds until the current rate limit window resets. example: 1 retryAfterSeconds: type: integer description: Present when the request was rate limited. example: 1 securitySchemes: PublicBearerAuth: type: http scheme: bearer bearerFormat: Opaque description: >- Public API access token issued by `/public/v1/oauth/token`. Example: `Authorization: Bearer fspt_...`. Each resource request rechecks the token company's current provider access. Disabling access blocks existing tokens with `403 auth.provider_unavailable`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.