{"openapi":"3.0.0","paths":{"/v1/workouts/metadata":{"get":{"operationId":"WorkoutsApi_getWorkoutMetadata","summary":"Get available workout categories and difficulties","description":"\n## Workout categories & difficulties\n\nReturns category ids/names and difficulty strings for filters and AI generate `categoryId`.\n\n**Try it:** `GET /v1/workouts/metadata` with `X-Api-Key`. Optional `locale`.\n\n**Related:** `GET /v1/workouts/equipment/metadata`, `GET /v1/workouts/exercises/metadata`, `POST /v1/orgs/{orgId}/workouts/generate`.\n ","parameters":[{"name":"locale","required":false,"in":"query","description":"Preferred language locale (e.g., fr-FR)","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved category and difficulty lists.","content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","description":"List of all available workout categories.","items":{"type":"object","properties":{"id":{"type":"string","description":"Category ID","example":"615aa3f0dbe7140012c59e94"},"name":{"type":"string","description":"Category display name","example":"HIIT"}},"required":["id","name"]}},"difficulties":{"type":"array","description":"List of all available difficulty levels.","items":{"type":"string","example":"intermediate"}}},"example":{"categories":[{"id":"615aa3f0dbe7140012c59e94","name":"HIIT"},{"id":"615aa3dadbe7140012c59e90","name":"Strength"},{"id":"615aa3e5dbe7140012c59e92","name":"Mobility"}],"difficulties":["beginner","intermediate","advanced"]}}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["workouts"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/workouts/metadata' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getWorkoutMetadata() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/workouts/metadata', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/workouts/metadata\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/workouts/equipment/metadata":{"get":{"operationId":"WorkoutsApi_getEquipmentMetadata","summary":"Get available equipment categories and equipment items","description":"\n## Equipment metadata\n\nReturns equipment categories and items for filters and generate `preferredEquipmentCategoryIds`.\n\n**Try it:** `GET /v1/workouts/equipment/metadata` with `X-Api-Key`. Optional `locale`.\n\n**Related:** `GET /v1/workouts/metadata`, `POST /v1/orgs/{orgId}/workouts/generate`.\n ","parameters":[{"name":"locale","required":false,"in":"query","description":"Preferred language locale (e.g., fr-FR)","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved equipment and category lists.","content":{"application/json":{"schema":{"type":"object","properties":{"categories":{"type":"array","description":"List of all available equipment categories.","items":{"type":"object","properties":{"id":{"type":"string","description":"Category ID","example":"67deb36a6a5e49797c122f56"},"name":{"type":"string","description":"Category display name","example":"Bodyweight"},"category":{"type":"string","description":"Broader category grouping","example":"bodyweight"}},"required":["id","name","category"]}},"equipment":{"type":"array","description":"List of all available equipment items.","items":{"type":"object","properties":{"id":{"type":"string","description":"Equipment ID","example":"60812dea606fc90011eb4405"},"name":{"type":"string","description":"Equipment display name","example":"Dumbbell"},"equipmentCategoryId":{"type":"string","description":"ID of the category this equipment belongs to (optional)","example":"67deb3696a5e49797c122f55","nullable":true}},"required":["id","name"]}}},"example":{"categories":[{"id":"67deb36a6a5e49797c122f56","name":"Bodyweight","category":"bodyweight"},{"id":"67deb3696a5e49797c122f55","name":"Free Weights","category":"free_weights"},{"id":"67deb36a6a5e49797c122f57","name":"Gym Equipment","category":"gym"}],"equipment":[{"id":"60812dea606fc90011eb4405","name":"Dumbbell","equipmentCategoryId":"67deb3696a5e49797c122f55"},{"id":"60812dd5606fc90011eb4404","name":"Kettlebell","equipmentCategoryId":"67deb3696a5e49797c122f55"},{"id":"60812e08606fc90011eb4408","name":"Mat","equipmentCategoryId":"67deb36a6a5e49797c122f56"}]}}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["workouts"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/workouts/equipment/metadata' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getEquipmentMetadata() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/workouts/equipment/metadata', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/workouts/equipment/metadata\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/workouts/{workoutId}":{"get":{"operationId":"WorkoutsApi_getWorkout","summary":"Get workout details","description":"\n## Workout details\n\nFull document for a **persisted** workout id, wrapped as `{ data: { id, name, duration, difficulty, categories, equipment, muscleGroupPercentages, preview, mixBgMusic, videoAudioMode, ... } }`.\n\n**Try it:** `GET /v1/workouts/{workoutId}` with `X-Api-Key`. Optional `locale` for localized display fields.\n\n**Related:** `GET /v1/workouts/{id}/playlist`, `GET /v1/workouts/{id}/music`, `GET /v1/orgs/{orgId}/workouts`.\n ","parameters":[{"name":"workoutId","required":true,"in":"path","description":"The unique identifier (24-character hex string) of the workout to retrieve.","example":"12ab3efd45c67c1234566cd1","schema":{"type":"string"}},{"name":"locale","required":false,"in":"query","description":"Preferred language locale (e.g., fr-FR)","schema":{"type":"string"}}],"responses":{"200":{"description":"Workout details retrieved successfully.","schema":{"example":{"data":{"id":"12ab3efd45c67c1234566cd1","name":"Full Body HIIT Power","description":"A high-intensity interval training session targeting full body strength and cardiovascular fitness","duration":1800,"difficulty":"intermediate","visibility":"public","locked":false,"createdAt":"2023-10-26T10:00:00.000Z","updatedAt":"2023-10-27T11:30:00.000Z","trainer":{"id":"64f1a2b3c4d5e6f7a8b9c0d4","name":"Sarah Johnson"},"categories":[{"id":"615aa3f0dbe7140012c59e94","name":"HIIT"},{"id":"615aa3ebdbe7140012c59e93","name":"Cardio"}],"equipment":[{"id":"60812dea606fc90011eb4405","name":"Dumbbell","equipmentCategoryId":"67deb3696a5e49797c122f55"},{"id":"60812e08606fc90011eb4408","name":"Mat","equipmentCategoryId":"67deb36a6a5e49797c122f56"}],"muscleGroupPercentages":[{"muscleGroupId":"604b0129beaba770c284ff40","muscleGroupName":"Arms","percentage":25.5},{"muscleGroupId":"604b0169076fe2727354d740","muscleGroupName":"Chest","percentage":20},{"muscleGroupId":"604b0177076fe2727354d743","muscleGroupName":"Legs","percentage":30},{"muscleGroupId":"604b0170076fe2727354d741","muscleGroupName":"Core","percentage":24.5}],"preview":{"url":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/workout-preview.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=604800&X-Amz-Signature=...","poster":"https://images.hyperhuman.cc/workout-poster.jpg","thumbnail":"https://images.hyperhuman.cc/workout-thumb.jpg"},"audioIntro":null,"audioOutro":null,"musicPlaylists":{"spotify":{"url":"https://open.spotify.com/playlist/37i9dQZF1DX76Wlfdnj7AP"},"youtube":null,"appleMusic":null,"amazonMusic":null},"shareLink":{"url":"https://app.hyperhuman.cc/workouts/12ab3efd45c67c1234566cd1"},"organization":null,"rating":4.5,"mixBgMusic":true,"presentationStyle":"full","skipWorkoutPreview":false,"skipWorkoutCompletionScreen":false,"videoAudioMode":"full","allowAssessment":false,"assessmentType":null}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutResponse"}}}},"401":{"description":"Authentication failed - API key is missing, invalid, or Bearer token is missing/invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The specified workout ID does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["workouts"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/workouts/' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getWorkout() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/workouts/', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/workouts/\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/workouts/{workoutId}/export/video/stream_url":{"get":{"operationId":"WorkoutsApi_getExportVideoStream","summary":"Get complete workout video export URL","description":"\n## Full workout video export\n\nReturns a presigned URL to the full-workout video export for a persisted workout id.\n\n**Response:** **200** `Content-Type: text/plain` — body is a **single** URL string (not JSON), valid ~**7 days**. Linked asset matches the stored render (commonly MP4).\n\n**Locale:** omit → latest available export; provide `locale` → exact locale only (**404** if that locale is not rendered — no English fallback). Still processing / missing → **404** (typically 2–5 minutes after create).\n\n**Rate limit:** **10x**. Prefer `/playlist` for interactive segment playback.\n\n**Related:** `GET /v1/workouts/{id}`, `GET /v1/workouts/{id}/playlist`, `GET /v1/workouts/{id}/export/audio/stream_url`.\n ","parameters":[{"name":"workoutId","required":true,"in":"path","description":"The unique identifier of the workout.","example":"12ab3efd45c67c1234566cd1","schema":{"type":"string"}},{"name":"locale","required":false,"in":"query","description":"Language locale (e.g., de-DE, fr-FR, en-US). When omitted, the latest available export is returned. When provided, only the exact-locale export is returned; if it does not exist the endpoint returns 404 (no en-US/default fallback).","example":"en-US","schema":{"type":"string"}}],"responses":{"200":{"description":"text/plain body: a single presigned HTTPS URL to the full video export (valid 7 days). Format of the linked asset matches the stored render (commonly MP4; see operation description).","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Authentication failed - API key is missing, invalid, or Bearer token is missing/invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Workout not found, video export not available for the requested locale, or video is still being generated (processing typically takes 2-5 minutes after workout creation).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["workouts"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/workouts//export/video/stream_url' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getExportVideoStream() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/workouts//export/video/stream_url', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/workouts//export/video/stream_url\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/workouts/{workoutId}/export/audio/stream_url":{"get":{"operationId":"WorkoutsApi_getExportAudioStream","summary":"Get audio-only workout export URL","description":"\n## Full workout audio export\n\nReturns a presigned URL to the full narrative audio export for a persisted workout id.\n\n**Response:** **200** `Content-Type: text/plain` — body is a **single** URL string (not JSON), valid ~**7 days** (commonly M4A).\n\n**Locale:** omit → resolve with the trainer **preferred locale** (language-family fallback within that language; never cross-language). Provide `locale` → exact match, then same-language family; missing / still processing → **404** (not the same as video export’s “latest any locale / exact-or-404”).\n\n**Rate limit:** **10x**.\n\n**Related:** `GET /v1/workouts/{id}/export/video/stream_url`, `GET /v1/workouts/{id}/playlist`, `GET /v1/workouts/{id}`.\n ","parameters":[{"name":"workoutId","required":true,"in":"path","description":"The unique identifier of the workout.","example":"12ab3efd45c67c1234566cd1","schema":{"type":"string"}},{"name":"locale","required":false,"in":"query","description":"Language locale for audio narration (e.g., de-DE, fr-FR, en-US). When omitted, uses the trainer preferred locale with same-language family fallback. When provided, exact then family match; if none exists → 404 (never falls back to another language). Differs from video export locale rules.","example":"en-US","schema":{"type":"string"}}],"responses":{"200":{"description":"text/plain body: a single presigned HTTPS URL to the full narrative audio export (valid 7 days; commonly M4A/AAC).","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Authentication failed - API key is missing, invalid, or Bearer token is missing/invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Workout not found, audio export not available for the requested locale, or audio is still being generated (processing typically takes 1-3 minutes after workout creation).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["workouts"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/workouts//export/audio/stream_url' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getExportAudioStream() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/workouts//export/audio/stream_url', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/workouts//export/audio/stream_url\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/workouts/exercises/metadata":{"get":{"operationId":"WorkoutsApi_getExercisesMetadata","summary":"Get available muscle groups and exercise collections","description":"\n## Muscle groups & exercise collections\n\nReturns muscle group ids/names and collection names/counts for generate `muscleGroupIds` / `excludeExerciseCollections`.\n\n**Try it:** `GET /v1/workouts/exercises/metadata` with `X-Api-Key`. Optional `locale`.\n\n**Related:** `GET /v1/workouts/metadata`, `POST /v1/orgs/{orgId}/workouts/generate`.\n ","parameters":[{"name":"locale","required":false,"in":"query","description":"Preferred language locale (e.g., fr-FR)","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved list of muscle groups and exercise collections.","content":{"application/json":{"schema":{"type":"object","properties":{"muscleGroups":{"type":"array","description":"List of all available muscle groups.","items":{"type":"object","properties":{"id":{"type":"string","description":"Muscle group ID","example":"604b0129beaba770c284ff40"},"name":{"type":"string","description":"Muscle group display name","example":"Arms"}},"required":["id","name"]}},"collections":{"type":"array","description":"List of all available exercise collections with exercise counts.","items":{"type":"object","properties":{"name":{"type":"string","description":"Collection name","example":"Premium - Neutral"},"count":{"type":"number","description":"Number of exercises in this collection","example":808}},"required":["name","count"]}}},"example":{"muscleGroups":[{"id":"604b0129beaba770c284ff40","name":"Arms"},{"id":"604b0169076fe2727354d740","name":"Chest"},{"id":"604b0177076fe2727354d743","name":"Legs"}],"collections":[{"name":"Premium - Neutral","count":808},{"name":"Premium - Industrial","count":200},{"name":"Free - Eclectic Home","count":239}]}}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["workouts"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/workouts/exercises/metadata' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getExercisesMetadata() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/workouts/exercises/metadata', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/workouts/exercises/metadata\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/workouts":{"get":{"operationId":"OrganizationWorkoutsApi_getOrganizationWorkouts","summary":"List organization-specific workouts","description":"\n## Organization Workout Library\n\nPaginated list of **published** workouts for your organization (workspace).\n\n**Try it (minimal):** `GET /v1/orgs/{organizationId}/workouts?limit=20` with header `X-Api-Key`. Use your organization id from **Settings → Integrations**. Leave optional filters empty on the first call.\n\n**Pagination:** `limit` (default **20**, max **50**). Follow `links.next` in the response to advance pages.\n\n**Optional filters:** `visibility` (`all` default), `difficulty`, `categoryIds` (comma-separated hex ids from `GET /v1/workouts/metadata`), `duration` (`min-max` minutes), `q`, `sort` (`+` / `-` prefix, e.g. `-createdAt`), `allowAssessment`, `locale`.\n\n**Related:** `POST /v1/orgs/{orgId}/workouts/generate`, `POST /v1/orgs/{orgId}/workouts/recommend`, `GET /v1/workouts/{id}`, `GET /v1/workouts/metadata`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"Unique organization (workspace) resource id — opaque 24-character hex string. Use the organization id from Settings → Integrations.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return per page.","example":20,"schema":{"minimum":1,"maximum":50,"default":20,"type":"number"}},{"name":"q","required":false,"in":"query","description":"Search text","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"Fields to sort. Prefix them with - (descending) or + (ascending): +someField,-otherField","schema":{"type":"string"}},{"name":"locale","required":false,"in":"query","description":"BCP-47 locale (e.g. en-US, fr-FR). Localizes text and locale-aware media when this operation supports it. Falls back to English when unsupported.","example":"en-US","schema":{"type":"string"}},{"name":"visibility","required":false,"in":"query","description":"Filter workouts by their visibility status. Defaults to `all` when omitted (private and public).","schema":{"enum":["private","public","all"],"type":"string"}},{"name":"difficulty","required":false,"in":"query","description":"Filter workouts by difficulty level.","schema":{"enum":["beginner","intermediate","advanced"],"type":"string"}},{"name":"categoryIds","required":false,"in":"query","description":"Filter workouts by one or more workout category IDs (comma-separated 24-character hex DB ids). Discover ids via `GET /v1/workouts/metadata`. Optional tokens prefixed with `custom:` are filtered in memory (e.g. `custom:duration_short`).","schema":{"type":"string"}},{"name":"duration","required":false,"in":"query","description":"Filter workouts by duration range in minutes. Use \"min-max\" (e.g., \"10-30\") or an open-ended range like \"60-\" (60+ min) or \"-30\" (up to 30 min).","schema":{"pattern":"^(\\d+-\\d*|\\d*-\\d+)$","type":"string"}},{"name":"allowAssessment","required":false,"in":"query","description":"Filter workouts by assessment support","schema":{"type":"boolean"}}],"responses":{"200":{"description":"Successfully retrieved paginated list of workouts for the organization.","schema":{"example":{"data":[{"id":"64f1a2b3c4d5e6f7a8b9c0d1","trainer":{"id":"64f1a2b3c4d5e6f7a8b9c0d4","name":"Sarah Johnson"},"createdAt":"2025-09-15T10:30:00.000Z","updatedAt":"2025-09-16T08:00:00.000Z","name":"Morning Power HIIT","description":"High-intensity intervals to start your day","duration":1800,"difficulty":"intermediate","visibility":"public","categories":[{"id":"615aa3f0dbe7140012c59e94","name":"HIIT"}],"preview":{"url":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/morning-hiit.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=604800&X-Amz-Signature=...","poster":"https://images.hyperhuman.cc/morning-hiit-poster.jpg","thumbnail":"https://images.hyperhuman.cc/morning-hiit-poster.jpg"},"rating":4.6,"locked":false,"mixBgMusic":true,"presentationStyle":"full","skipWorkoutPreview":false,"skipWorkoutCompletionScreen":false,"videoAudioMode":"full","allowAssessment":false,"assessmentType":null}],"links":{"next":"https://content.api.hyperhuman.cc/v1/orgs/63415bf67a9c7000126616c1/workouts?offset=20&limit=20","total":45}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutListResponse"}}}},"400":{"description":"Invalid pagination or filter parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"The specified organization ID does not exist.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["workouts"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"Minimal","source":"curl -s 'https://content.api.hyperhuman.cc/v1/orgs//workouts?limit=20' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"curl","label":"With filters","source":"curl -s 'https://content.api.hyperhuman.cc/v1/orgs//workouts?limit=20&visibility=public&difficulty=intermediate&categoryIds=615aa3f0dbe7140012c59e94&duration=20-30&q=HIIT' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getOrganizationWorkouts() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//workouts?limit=20', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//workouts?limit=20\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/workouts/recommend":{"post":{"operationId":"OrganizationWorkoutRecommendation_getWorkoutRecommendations","summary":"Get workout recommendations from existing library","description":"\n## Recommend workouts from your library\n\nRanks **existing published workouts** in your organization library for a user profile. Use this when your team already creates workouts and you want to pair the best match (e.g. after a quiz). For a brand-new workout structure, use `POST .../workouts/generate` instead.\n\n**Try it (minimal):** body `{ \"endUserProfileDetails\": { \"age\": 30, \"fitnessLevels\": [\"beginner\"] } }` with header `X-Api-Key`. Response is a bare object `{ workouts, reasoning }` (not wrapped in `data`). Up to **12** workouts; each item includes a `recommendation` text reason (not a numeric score).\n\n**Body:** only `endUserProfileDetails` and optional `locale` — unknown keys return `400 ValidationError`.\n\n**Rate limit:** counts as **10x** toward hourly/daily limits.\n\n**Related:** `POST /v1/orgs/{orgId}/workouts/generate`, `GET /v1/orgs/{orgId}/workouts`, `GET /v1/workouts/metadata`, `GET /v1/workouts/{id}`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"Organization/Team unique identifier","example":"67e2e9d0e23f010013e19dec","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutRecommendationRequestDto"},"examples":{"minimal":{"summary":"Minimal profile","value":{"endUserProfileDetails":{"age":30,"fitnessLevels":["beginner"],"gender":"female"}}}}}}},"responses":{"200":{"description":"Ranked list of recommended workouts with per-item recommendation text and overall reasoning","schema":{"example":{"workouts":[{"id":"6a3cf00b9fe2d4001a58d605","name":"Beginner Flow & Core Pilates","description":"","duration":1185,"difficulty":"beginner","thumbnailUrl":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/poster_a_720p.jpg","recommendation":"Sculpt your core and legs with this beginner-friendly pilates flow.","categories":[{"id":"615aa3f5dbe7140012c59e95","name":"Pilates"}],"preview":{"url":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/preview.mp4","poster":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/poster_a_720p.jpg","thumbnail":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/poster_a_720p.jpg"}}],"reasoning":"Workouts recommended based on your profile and preferences."}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutRecommendationResponseDto"}}}},"401":{"description":"Unauthorized - Invalid API key"},"404":{"description":"Organization/Team not found"}},"tags":["ai-recommendation"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//workouts/recommend' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getWorkoutRecommendations() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//workouts/recommend', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\n \"https://content.api.hyperhuman.cc/v1/orgs//workouts/recommend\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/workouts/generate":{"post":{"operationId":"OrganizationWorkoutGeneration_generateWorkout","summary":"Generate personalized on-the-fly workouts based on user profile details, duration preferences, and exercise sources.","description":"\n## Generate a workout\n\nCreates an AI workout from profile, `categoryId`, duration options, and exercise sources. Prefer `POST .../workouts/recommend` when you only need a match from your existing library.\n\n**Playback / storage:** Response is **ephemeral JSON** (`name`, `instances[]` with `kind` `single-exercise`|`rest`, `totalDurationSeconds`, …) with **no top-level persisted workout `id`**. Not listed by `GET /v1/orgs/{orgId}/workouts`. Play via the JSON-receiver embed (`/embed/workout-json-receiver` + `HYPERHUMAN_EMBED_INIT`) or a custom player; the embed resolves media via `GET /v1/video-asset/{exerciseId}`. Do **not** call `/playlist` or `/music` (need a persisted id). JSON-receiver has **no** PulseMix and **no** session/feedback tracking — use the pre-built `/embed/workout/{id}` for those. Persist the JSON yourself if you need replay/audit later. See API overview **Embedded Player**.\n\n**Try it (minimal):** body `{ \"endUserProfileDetails\": { \"age\": 28, \"fitnessLevels\": [\"beginner\"] }, \"exerciseSources\": [\"premium_stock\"], \"durationOptions\": { \"minMinutes\": 10, \"maxMinutes\": 15 }, \"categoryId\": \"\" }` with `X-Api-Key`.\n\n**Sources:** `premium_stock` (production), `free_stock` (dev/test), `team_exercises` (your catalog). Omit → free+premium stock. Prefer `premium_stock` or `team_exercises` alone in production.\n\n**Exercise collections:** optional `includeExerciseCollections` (allowlist — only these `collectionName` values) or `excludeExerciseCollections` (denylist). Mutually exclusive — both non-empty → `400`. Compose with `exerciseSources` (AND). Prefer **include** to lock trainer/location/brand look; do not simulate include by excluding every other collection. Discover names via `GET /v1/workouts/exercises/metadata`. Filtered pool must have ≥ 10 exercises or request returns `400`.\n\n**Localization:** optional body `locale` (BCP-47). Unsupported → `400`. Additive `*Localized` / `nameTranslations` / `difficultyLabel` when non-English; legacy `name` / `difficulty` stay English.\n\n**Rate limit:** counts as **10x**.\n\n**Related:** `POST /v1/orgs/{orgId}/workouts/recommend`, `POST /v1/orgs/{orgId}/workouts/{workoutId}/adapt`, `GET /v1/video-asset/{id}`, `GET /v1/workouts/metadata`, `GET /v1/workouts/exercises/metadata`.\n","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"67e2e9d0e23f010013e19dec","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Workout generation request with user profile and preferences.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutGenerationRequestDto"},"examples":{"beginner-hiit-20min":{"summary":"Beginner HIIT - 20 Minutes","description":"Full-body HIIT workout for beginners with minimal equipment","value":{"endUserProfileDetails":{"age":28,"gender":"female","fitnessLevels":["beginner"],"trainingDaysPerWeek":3,"preferredEquipmentCategoryIds":["67deb36a6a5e49797c122f56"]},"exerciseSources":["premium_stock"],"durationOptions":{"minMinutes":15,"maxMinutes":20},"categoryId":"615aa3f0dbe7140012c59e94"}},"advanced-strength-upper-body":{"summary":"Advanced Strength - Upper Body Focus","description":"Advanced strength training targeting chest, arms, and shoulders with free weights","value":{"endUserProfileDetails":{"age":35,"gender":"male","fitnessLevels":["advanced"],"trainingDaysPerWeek":5,"preferredEquipmentCategoryIds":["67deb3696a5e49797c122f55"]},"exerciseSources":["premium_stock"],"durationOptions":{"minMinutes":30,"maxMinutes":45},"categoryId":"615aa3dadbe7140012c59e90","muscleGroupIds":["604b0169076fe2727354d740","604b0129beaba770c284ff40","604b0165076fe2727354d73e"],"excludeExerciseCollections":["Free - Outdoor"]}},"intermediate-mobility-recovery":{"summary":"Intermediate Mobility & Recovery","description":"Low-intensity mobility workout for active recovery","value":{"endUserProfileDetails":{"age":42,"gender":"female","fitnessLevels":["intermediate"],"trainingDaysPerWeek":4,"preferredEquipmentCategoryIds":["67deb36a6a5e49797c122f56"]},"exerciseSources":["premium_stock"],"durationOptions":{"minMinutes":10,"maxMinutes":15},"categoryId":"615aa3e5dbe7140012c59e92","userRequirements":"Focus on low-impact movements. Emphasize flexibility and joint mobility. Avoid high-intensity exercises."}},"team-branded-workout":{"summary":"Custom Team Exercises Only","description":"Use your organization's exercises for complete brand alignment","value":{"endUserProfileDetails":{"age":30,"gender":"male","fitnessLevels":["intermediate"],"trainingDaysPerWeek":3,"preferredEquipmentCategoryIds":["67deb3696a5e49797c122f55"]},"exerciseSources":["team_exercises"],"durationOptions":{"minMinutes":20,"maxMinutes":30},"categoryId":"615aa3f0dbe7140012c59e94"}},"team-branded-single-collection":{"summary":"Same trainer / location (include collections)","description":"Restrict the AI pool to one or more team exercise collections so every clip shares the same trainer and filming location. Prefer includeExerciseCollections over excluding every other collection.","value":{"endUserProfileDetails":{"age":30,"gender":"female","fitnessLevels":["intermediate"],"trainingDaysPerWeek":3,"preferredEquipmentCategoryIds":["67deb36a6a5e49797c122f56"]},"exerciseSources":["team_exercises"],"includeExerciseCollections":["Coach Mia - Loft"],"durationOptions":{"minMinutes":20,"maxMinutes":30},"categoryId":"615aa3f0dbe7140012c59e94"}},"cardio-legs-focus":{"summary":"Cardio with Legs Focus","description":"Cardio workout emphasizing leg muscles","value":{"endUserProfileDetails":{"age":26,"gender":"female","fitnessLevels":["intermediate"],"trainingDaysPerWeek":4,"preferredEquipmentCategoryIds":["67deb36a6a5e49797c122f56"]},"exerciseSources":["premium_stock"],"durationOptions":{"minMinutes":25,"maxMinutes":35},"categoryId":"615aa3ebdbe7140012c59e93","muscleGroupIds":["604b0177076fe2727354d743","604b0173076fe2727354d742"],"excludeExerciseCollections":["Premium - Industrial"]}},"complete-all-parameters":{"summary":"Complete Example - All Parameters","description":"Real-world example with ALL available parameters filled out to demonstrate the full API capability. This shows every possible field that can be included in a workout generation request.","value":{"endUserProfileDetails":{"age":32,"gender":"male","fitnessLevels":["intermediate","advanced"],"goalIds":["63c92926f920a9005c4e619c","63c92926f920a9005c4e619d"],"trainingDaysPerWeek":5,"preferredEquipmentCategoryIds":["67deb36a6a5e49797c122f56","67deb3696a5e49797c122f55"],"endUserId":"64e3bca9d1b7e600141a9712"},"exerciseSources":["premium_stock","team_exercises"],"durationOptions":{"minMinutes":30,"maxMinutes":45},"categoryId":"615aa3dadbe7140012c59e90","muscleGroupIds":["604b0169076fe2727354d740","604b0129beaba770c284ff40","604b0165076fe2727354d73e","604b016c076fe2727354d740","604b0170076fe2727354d741"],"excludeExerciseCollections":["Free - Eclectic Home","Free - Outdoor","Premium - Industrial"],"userRequirements":"Intermediate strength / stimulus, one-sided exercises, rep schemes. Focus on controlled movements suitable for osteoporosis patients. CRITICAL: USE up to 3 unique exercises in the whole workout.","locale":"fr-FR"}},"localized-fr-FR":{"summary":"Localized Workout (French)","description":"Minimal request with locale — returns French AI title and localized exercise metadata via additive *Localized fields.","value":{"endUserProfileDetails":{"age":28,"fitnessLevels":["intermediate"]},"exerciseSources":["premium_stock"],"durationOptions":{"minMinutes":10,"maxMinutes":15},"categoryId":"615aa3f0dbe7140012c59e94","locale":"fr-FR"}}}}}},"responses":{"200":{"description":"Successfully generated workout plan with automatic warm-up and cooldown sections. AI may adjust final difficulty based on exercise availability and safety considerations.","schema":{"example":{"name":"Intermediate Strength Builder","nameTranslations":{"en-US":"Intermediate Strength Builder","fr-FR":"Renforcement Musculaire Intermédiaire"},"totalDurationSeconds":660,"difficulty":"intermediate","difficultyLabel":"Intermédiaire","categoryId":"615aa3f0dbe7140012c59e94","category":{"id":"615aa3f0dbe7140012c59e94","name":"HIIT"},"instances":[{"id":"64f1a2b3c4d5e6f7a8b9c0d1","kind":"single-exercise","durationSeconds":30,"skipIntro":false,"pace":"medium","exercise":{"id":"6a2d0e568d5154001ac3ede8","name":"Lateral Hip Opener","nameLocalized":"Lateral Hip Opener","thumbnailUrl":"https://cdn.example.com/exercises/thumbnails/lateral-hip-opener.jpg","videoUri":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/lateral-hip-opener.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=604800&X-Amz-Signature=...","estimatedRepDuration":1500,"muscleGroups":["Legs","Glutes"],"muscleGroupsLocalized":[{"id":"604b0177076fe2727354d743","name":"Jambes"},{"id":"604b0173076fe2727354d742","name":"fessiers"}],"equipment":["Mat"],"equipmentLocalized":[{"id":"60812e08606fc90011eb4408","name":"Tapis"}]}},{"id":"64f1a2b3c4d5e6f7a8b9c0d2","kind":"rest","durationSeconds":15},{"id":"64f1a2b3c4d5e6f7a8b9c0d3","kind":"single-exercise","reps":12,"skipIntro":true,"weightLevel":"medium","exercise":{"id":"60812dea606fc90011eb4406","name":"Push-ups","nameLocalized":"Pompes","thumbnailUrl":"https://cdn.example.com/exercises/thumbnails/push-ups.jpg","videoUri":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/push-ups.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=604800&X-Amz-Signature=...","estimatedRepDuration":2000,"muscleGroups":["Chest","Arms","Core"],"muscleGroupsLocalized":[{"id":"604b0169076fe2727354d740","name":"Poitrine"},{"id":"604b0129beaba770c284ff40","name":"Bras"}],"equipment":["Bodyweight"],"equipmentLocalized":[{"id":"67deb36a6a5e49797c122f56","name":"Poids du corps"}]}}]}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutGenerationResponseDto"}}}},"400":{"description":"Bad Request — invalid input, unsupported locale, include+exclude collections together, or filtered exercise pool below 10 after collection/source filters.","schema":{"example":{"error":{"message":"Invalid categoryId provided","statusCode":400,"errorCode":"INVALID_CATEGORY_ID","details":"The categoryId '615aa3f0dbe7140012c59e99' does not exist. Please use GET /v1/workouts/metadata to fetch valid category IDs."}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized - Invalid API key.","schema":{"example":{"error":{"message":"Invalid API key","statusCode":401,"errorCode":"UNAUTHORIZED"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden - API key required or insufficient permissions.","schema":{"example":{"error":{"message":"API key required","statusCode":403,"errorCode":"FORBIDDEN","details":"This endpoint requires a valid API key. Please include the X-Api-Key header with your request."}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found - Organization or other resources not found.","schema":{"example":{"error":{"message":"Organization not found","statusCode":404,"errorCode":"ORGANIZATION_NOT_FOUND","details":"The organization with ID '67e2e9d0e23f010013e19dec' does not exist or your API key does not have access to it."}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error - Failed to generate workout.","schema":{"example":{"error":{"message":"Failed to generate workout plan due to an internal issue.","statusCode":500,"errorCode":"INTERNAL_SERVER_ERROR"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["ai-generation"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//workouts/generate' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function generateWorkout() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//workouts/generate', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\n \"https://content.api.hyperhuman.cc/v1/orgs//workouts/generate\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/workouts/{workoutId}/adapt":{"post":{"operationId":"OrganizationWorkoutAdaptation_adaptWorkout","summary":"Adapt an existing team workout based on user profile and data","description":"\n## Adapt a team workout\n\nPersonalizes an existing organization workout (intensity, duration, exercise substitutions) from profile signals, recent session/feedback history, optional wearable context, and `userGuidance`. Goals and overall structure intent of the source workout are preserved. The source `{workoutId}` must belong to `{organizationId}` (otherwise `404`).\n\n**Playback / storage:** Same as workout **generate** — ephemeral `{ name, instances[], … }` (no top-level workout `id`). Play via the JSON-receiver **iframe** + `HYPERHUMAN_EMBED_INIT` (media via `GET /v1/video-asset/{exerciseId}`) or a custom player. No `/playlist`, `/music`, or sessions/feedback. Prefer `POST .../workouts/recommend` for a library match. See API overview **Embedded Player**.\n\n**Rate limit:** counts as **10x**.\n\n**Related:** `POST /v1/orgs/{orgId}/workouts/generate`, `POST /v1/orgs/{orgId}/workouts/recommend`, `GET /v1/orgs/{orgId}/workouts`, `GET /v1/workouts/{id}`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"Organization/Team ID","example":"67e2e9d0e23f010013e19dec","schema":{"type":"string"}},{"name":"workoutId","required":true,"in":"path","description":"Workout ID to adapt","example":"67e2e9d0e23f010013e19def","schema":{"type":"string"}}],"requestBody":{"required":true,"description":"Workout adaptation request with user profile and preferences","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutAdaptationRequestDto"},"examples":{"basic-adaptation":{"summary":"Basic Adaptation - Intermediate User","description":"Adapt a workout for an intermediate fitness level user","value":{"endUserProfileDetails":{"age":32,"gender":"female","fitnessLevels":["intermediate"],"trainingDaysPerWeek":4},"exerciseSources":["premium_stock","team_exercises"]}},"injury-adaptation":{"summary":"Adaptation with Injury Guidance","description":"Adapt a workout considering user injury","value":{"endUserProfileId":"64e3bca9d1b7e600141a9712","endUserProfileDetails":{"age":45,"gender":"male","fitnessLevels":["beginner"],"trainingDaysPerWeek":3},"exerciseSources":["premium_stock"],"userGuidance":"I have a slight knee injury. Please avoid high-impact exercises like jumping and running. Prefer low-impact alternatives."}},"full-personalization":{"summary":"Full Personalization with User Data","description":"Adapt using 60-day wearable data and full user profile","value":{"endUserProfileId":"64e3bca9d1b7e600141a9712","endUserProfileDetails":{"age":28,"gender":"female","fitnessLevels":["advanced"],"goalIds":["63c92926f920a9005c4e619c"],"trainingDaysPerWeek":5,"preferredEquipmentCategoryIds":["67deb36a6a5e49797c122f56","67deb3696a5e49797c122f55"]},"exerciseSources":["premium_stock","team_exercises"],"userGuidance":"Training for a 10K run in 2 months. Focus on building endurance. Limited time today, prefer shorter workout."}}}}}},"responses":{"200":{"description":"Adapted workout with personalized adjustments","schema":{"example":{"name":"Adapted: Full Body HIIT Power","totalDurationSeconds":1050,"difficulty":"intermediate","categoryId":"615aa3f0dbe7140012c59e94","adaptationReasoning":"Reduced workout duration from 20 to 17.5 minutes to accommodate your current fitness level. Adjusted rest periods to 20 seconds (from 15) to allow better recovery. Modified exercise intensity by reducing reps for high-impact movements to protect your knee. Substituted jumping exercises with low-impact alternatives.","instances":[{"id":"64f1a2b3c4d5e6f7a8b9c0d1","kind":"single-exercise","durationSeconds":30,"skipIntro":false,"pace":"medium","exercise":{"id":"60812dea606fc90011eb4405","name":"Jumping Jacks","description":"Full body cardio warm-up exercise","thumbnailUrl":"https://cdn.example.com/exercises/thumbnails/jumping-jacks.jpg","videoUri":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/jumping-jacks.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=604800&X-Amz-Signature=...","estimatedRepDuration":1500,"muscleGroups":["Full Body","Cardio"],"equipment":["Bodyweight"],"collectionName":"Premium - Neutral","coach":"female","skillLevel":"beginner","categories":["warmup","cardio"]}},{"id":"64f1a2b3c4d5e6f7a8b9c0d2","kind":"rest","durationSeconds":20},{"id":"64f1a2b3c4d5e6f7a8b9c0d3","kind":"single-exercise","reps":10,"skipIntro":true,"weightLevel":"medium","rpe":7,"exercise":{"id":"60812dea606fc90011eb4406","name":"Modified Push-ups","description":"Upper body strength exercise adapted for lower intensity","thumbnailUrl":"https://cdn.example.com/exercises/thumbnails/push-ups.jpg","videoUri":"https://hhcontent.s3.eu-central-1.amazonaws.com/example/push-ups.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=604800&X-Amz-Signature=...","estimatedRepDuration":2000,"muscleGroups":["Chest","Arms"],"equipment":["Bodyweight"],"collectionName":"Premium - Neutral","coach":"female","skillLevel":"intermediate","categories":["strength"]}}]}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WorkoutAdaptationResponseDto"}}}},"400":{"description":"Invalid request or workout not eligible for adaptation (only team workouts can be adapted)"},"401":{"description":"Unauthorized - Invalid API key"},"404":{"description":"Workout or organization not found"}},"tags":["ai-adaptation"],"security":[{"AccessToken":[]},{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//workouts//adapt' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function adaptWorkout() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//workouts//adapt', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\n \"https://content.api.hyperhuman.cc/v1/orgs//workouts//adapt\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/content-autopilot":{"get":{"operationId":"OrganizationContentAutopilotApi_listTasks","summary":"List content autopilot tasks","description":"\n## Content Autopilot Tasks\n\nRetrieves a paginated list of content autopilot tasks for your organization. Autopilot tasks automate the creation, adaptation, and publishing of workouts and programs on a configurable schedule.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Use Cases\n\n- **Dashboard views** - List all scheduled content automation tasks\n- **Status monitoring** - Filter by active/draft to see running vs paused tasks\n- **Content type filtering** - Show only workout or program automation tasks\n- **Audit and review** - Browse task configurations for the organization\n\n---\n\n### Filtering and Pagination\n\n**Filters:**\n- `status` - active, draft\n- `scope` - ai_generate, create_similar, publish_existing\n- `contentType` - workout, program\n\n**Sort:** `sortBy` (updatedAt, createdAt) + `sortOrder` (ascend, descend)\n\n**Pagination:**\n- `limit` - Items per page (default: 20, max: 50)\n- `offset` - Pagination offset (default: 0)\n\n---\n\n### Related Endpoints\n\n- Get Task: `GET /v1/orgs/{orgId}/content-autopilot/{taskId}`\n- Create Task: `POST /v1/orgs/{orgId}/content-autopilot`\n- Task Events: `GET /v1/orgs/{orgId}/content-autopilot/{taskId}/events`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Items per page. Defaults to 20, max 50.","example":20,"schema":{"minimum":1,"maximum":50,"default":20,"type":"number"}},{"name":"status","required":false,"in":"query","description":"Filter by task status","schema":{"enum":["active","draft"],"type":"string"}},{"name":"scope","required":false,"in":"query","description":"Filter by task scope","schema":{"enum":["ai_generate","create_similar","publish_existing"],"type":"string"}},{"name":"contentType","required":false,"in":"query","description":"Filter by content type","schema":{"enum":["workout","program"],"type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"Sort by field","schema":{"enum":["updatedAt","createdAt"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"enum":["ascend","descend"],"type":"string"}},{"name":"offset","required":false,"in":"query","description":"Pagination offset. Defaults to 0.","example":0,"schema":{"type":"number"}}],"responses":{"200":{"description":"Successfully retrieved paginated list of autopilot tasks.","content":{"application/json":{"examples":{"default":{"summary":"List of autopilot tasks","value":{"data":[{"id":"64f1a2b3c4d5e6f7a8b9c0d1","organizationId":"63415bf67a9c7000126616c1","ownerId":"507f1f77bcf86cd799439011","name":"Daily HIIT Generator","status":"active","scope":"ai_generate","contentType":"workout","difficultyOptions":["beginner","intermediate"],"includeFreeStock":true,"includePremiumStock":false,"includeTeamContent":false,"repeatMode":"daily","nextRunAt":"2026-04-06T10:00:00.000Z","createdAt":"2026-04-01T08:00:00.000Z","updatedAt":"2026-04-05T14:00:00.000Z"}],"links":{"next":null,"total":1},"explanation":"Showing 1 autopilot task for your organization."}}}}}},"400":{"description":"Invalid filter or pagination parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function listTasks() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]},"post":{"operationId":"OrganizationContentAutopilotApi_createTask","summary":"Create content autopilot task","description":"\n## Create Autopilot Task\n\nCreates a new content autopilot task in `draft` status. Use the activate endpoint to start the scheduling.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Task Scopes\n\n| Scope | Description | Required Fields |\n|-------|-------------|-----------------|\n| `ai_generate` | Generate new content using AI | categoryIds/goalIds, difficultyOptions |\n| `create_similar` | Adapt an existing workout/program | `sourceContentId` |\n| `publish_existing` | Flip visibility to public on schedule | `existingContentId` |\n\n---\n\n### Prompt Guidance Modes\n\n| Mode | Description |\n|------|-------------|\n| `none` | No additional prompt context |\n| `custom` | User-written free text (`customPromptGuidance`) |\n| `ai_tuned` | 30-day analytics context appended to prompt |\n| `ai_driven` | Fully autonomous - AI decides category, difficulty, duration |\n\n---\n\n### Validation\n\n- `minutesLimit` entitlement must have remaining capacity\n- `premiumStock` entitlement required if `includePremiumStock` is true\n- `sourceContentId` / `existingContentId` must belong to the organization\n\n---\n\n### Related Endpoints\n\n- Activate: `POST /v1/orgs/{orgId}/content-autopilot/{taskId}/activate`\n- Update: `PATCH /v1/orgs/{orgId}/content-autopilot/{taskId}`\n- List: `GET /v1/orgs/{orgId}/content-autopilot`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAutopilotTaskDto"},"examples":{"aiGenerate":{"summary":"AI-generated daily workout","value":{"name":"Daily HIIT Generator","scope":"ai_generate","contentType":"workout","categoryIds":["615aa3f0dbe7140012c59e94"],"difficultyOptions":["beginner","intermediate"],"durationMin":15,"durationMax":30,"includeFreeStock":true,"repeatMode":"daily","promptGuidanceMode":"ai_driven"}},"createSimilar":{"summary":"Weekly workout variation","value":{"name":"Monday Strength Variation","scope":"create_similar","contentType":"workout","sourceContentId":"507f1f77bcf86cd799439011","difficultyOptions":["intermediate"],"repeatMode":"weekly"}},"publishExisting":{"summary":"Scheduled publish","value":{"name":"Publish Friday Program","scope":"publish_existing","contentType":"program","existingContentId":"507f1f77bcf86cd799439012","difficultyOptions":["beginner"],"repeatMode":"once","nextRunAt":"2026-04-10T09:00:00.000Z"}}}}}},"responses":{"201":{"description":"Task created in draft status.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutopilotTaskResponseDto"}}}},"400":{"description":"Invalid input or missing required fields for scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Entitlement limit exceeded or API key not authorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function createTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\n \"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/content-autopilot/events":{"get":{"operationId":"OrganizationContentAutopilotApi_listTeamEvents","summary":"List execution events across all tasks","description":"\n## Organization Autopilot Events\n\nRetrieves execution history across all content autopilot tasks for the organization. Each event records a task execution outcome: success, failure, or skip.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Use Cases\n\n- **Execution dashboard** - View recent automation activity across all tasks\n- **Failure monitoring** - Filter by `failed` to identify issues\n- **Audit trail** - Review content creation history with content IDs\n\n---\n\n### Filtering\n\n- `taskId` - Filter events to a specific task\n- `eventType` - success, failed, skipped_limit, skipped_premium_lost\n\n---\n\n### Related Endpoints\n\n- List Tasks: `GET /v1/orgs/{orgId}/content-autopilot`\n- Task Events: `GET /v1/orgs/{orgId}/content-autopilot/{taskId}/events`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Items per page. Defaults to 20, max 50.","example":20,"schema":{"minimum":1,"maximum":50,"default":20,"type":"number"}},{"name":"eventType","required":false,"in":"query","description":"Filter by event type","schema":{"enum":["success","failed","skipped_limit","skipped_premium_lost"],"type":"string"}},{"name":"taskId","required":false,"in":"query","description":"Filter events to a specific task","schema":{"type":"string"}},{"name":"offset","required":false,"in":"query","description":"Pagination offset. Defaults to 0.","example":0,"schema":{"type":"number"}}],"responses":{"200":{"description":"Successfully retrieved execution events.","content":{"application/json":{"examples":{"default":{"summary":"Execution event list","value":{"data":[{"id":"64f1a2b3c4d5e6f7a8b9c0e1","taskId":"64f1a2b3c4d5e6f7a8b9c0d1","organizationId":"63415bf67a9c7000126616c1","ownerId":"507f1f77bcf86cd799439011","eventType":"success","resultContentId":"64f1a2b3c4d5e6f7a8b9c0f1","resultContentType":"workout","createdAt":"2026-04-05T10:00:00.000Z"}],"links":{"next":null,"total":1}}}}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/events' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function listTeamEvents() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/events', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/events\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/content-autopilot/{taskId}":{"get":{"operationId":"OrganizationContentAutopilotApi_getTask","summary":"Get autopilot task by ID","description":"\n## Autopilot Task Detail\n\nReturns full configuration of a content autopilot task including schedule, content parameters, and prompt guidance settings.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Related Endpoints\n\n- List Tasks: `GET /v1/orgs/{orgId}/content-autopilot`\n- Update Task: `PATCH /v1/orgs/{orgId}/content-autopilot/{taskId}`\n- Task Events: `GET /v1/orgs/{orgId}/content-autopilot/{taskId}/events`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the autopilot task.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved autopilot task detail.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutopilotTaskResponseDto"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Task not found or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]},"patch":{"operationId":"OrganizationContentAutopilotApi_updateTask","summary":"Update autopilot task configuration","description":"\n## Update Autopilot Task\n\nPartially updates an autopilot task's configuration. All fields are optional. Fields not included in the request body remain unchanged.\n\nNotable: update `nextRunAt` to reschedule an active task to a different day without affecting its repeat configuration.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Related Endpoints\n\n- Get Task: `GET /v1/orgs/{orgId}/content-autopilot/{taskId}`\n- Activate: `POST /v1/orgs/{orgId}/content-autopilot/{taskId}/activate`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the autopilot task.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateAutopilotTaskDto"},"examples":{"reschedule":{"summary":"Reschedule to a different date","value":{"nextRunAt":"2026-04-12T09:00:00.000Z"}},"updateConfig":{"summary":"Update difficulty and duration","value":{"difficultyOptions":["intermediate","advanced"],"durationMin":20,"durationMax":40}}}}}},"responses":{"200":{"description":"Task updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutopilotTaskResponseDto"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Task not found or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X PATCH 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function updateTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/', {\n method: 'PATCH',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.patch(\n \"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]},"delete":{"operationId":"OrganizationContentAutopilotApi_deleteTask","summary":"Delete autopilot task (soft delete)","description":"\n## Delete Autopilot Task\n\nSoft-deletes a content autopilot task. The task will no longer execute and will not appear in list results.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Related Endpoints\n\n- List Tasks: `GET /v1/orgs/{orgId}/content-autopilot`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the autopilot task.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"204":{"description":"Task deleted."},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Task not found or already deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X DELETE 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function deleteTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/', {\n method: 'DELETE',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.delete(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot/\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/content-autopilot/{taskId}/activate":{"post":{"operationId":"OrganizationContentAutopilotApi_activateTask","summary":"Activate autopilot task","description":"\n## Activate Task\n\nSets the task status to `active` and determines the next scheduled execution time.\n\n**Schedule resolution:**\n1. If the task already has a `nextRunAt` in the future, it is preserved.\n2. Otherwise, `nextRunAt` is computed from the task's `repeatMode`.\n3. For `once` mode, defaults to now.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Related Endpoints\n\n- Deactivate: `POST /v1/orgs/{orgId}/content-autopilot/{taskId}/deactivate`\n- Run Now: `POST /v1/orgs/{orgId}/content-autopilot/{taskId}/run-now`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the autopilot task.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"200":{"description":"Task activated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutopilotTaskResponseDto"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Task not found or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//activate' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function activateTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//activate', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//activate\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/content-autopilot/{taskId}/deactivate":{"post":{"operationId":"OrganizationContentAutopilotApi_deactivateTask","summary":"Deactivate autopilot task","description":"\n## Deactivate Task\n\nSets the task status to `draft` and clears the `nextRunAt` schedule. The task will stop executing until activated again.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Related Endpoints\n\n- Activate: `POST /v1/orgs/{orgId}/content-autopilot/{taskId}/activate`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the autopilot task.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"200":{"description":"Task deactivated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutopilotTaskResponseDto"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Task not found or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//deactivate' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function deactivateTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//deactivate', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//deactivate\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/content-autopilot/{taskId}/run-now":{"post":{"operationId":"OrganizationContentAutopilotApi_runNow","summary":"Manually trigger task execution","description":"\n## Run Now\n\nExecutes a content autopilot task immediately, bypassing the cron schedule. Respects all entitlement limits and daily execution caps (max 20 per user per day).\n\nThe task can be in any status (active or draft) -- this allows testing a task configuration before activating it on a schedule.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Rate Limit\n\nThis endpoint triggers AI content generation and counts as 10x API calls toward your hourly and daily limits.\n\n---\n\n### Related Endpoints\n\n- Activate: `POST /v1/orgs/{orgId}/content-autopilot/{taskId}/activate`\n- Task Events: `GET /v1/orgs/{orgId}/content-autopilot/{taskId}/events`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the autopilot task.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"200":{"description":"Task executed successfully."},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Entitlement limit exceeded or API key not authorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Task not found or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//run-now' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function runNow() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//run-now', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//run-now\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/content-autopilot/{taskId}/events":{"get":{"operationId":"OrganizationContentAutopilotApi_listTaskEvents","summary":"List execution events for a task","description":"\n## Task Execution History\n\nRetrieves the execution event log for a specific autopilot task. Each event records a task run outcome.\n\n**Event types:**\n- `success` - Content created and published successfully. `resultContentId` contains the new content ID.\n- `failed` - Execution failed. `errorMessage` contains the reason.\n- `skipped_limit` - Daily execution limit (20/day) reached. Task retries next day.\n- `skipped_premium_lost` - Premium stock entitlement lost. Schedule advanced.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n\n---\n\n### Related Endpoints\n\n- Get Task: `GET /v1/orgs/{orgId}/content-autopilot/{taskId}`\n- Team Events: `GET /v1/orgs/{orgId}/content-autopilot/events`\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the autopilot task.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Items per page. Defaults to 20, max 50.","example":20,"schema":{"minimum":1,"maximum":50,"default":20,"type":"number"}},{"name":"eventType","required":false,"in":"query","description":"Filter by event type","schema":{"enum":["success","failed","skipped_limit","skipped_premium_lost"],"type":"string"}},{"name":"offset","required":false,"in":"query","description":"Pagination offset. Defaults to 0.","example":0,"schema":{"type":"number"}}],"responses":{"200":{"description":"Successfully retrieved task execution events.","content":{"application/json":{"examples":{"default":{"summary":"Task execution history","value":{"data":[{"id":"64f1a2b3c4d5e6f7a8b9c0e1","taskId":"64f1a2b3c4d5e6f7a8b9c0d1","organizationId":"63415bf67a9c7000126616c1","ownerId":"507f1f77bcf86cd799439011","eventType":"success","resultContentId":"64f1a2b3c4d5e6f7a8b9c0f1","resultContentType":"workout","createdAt":"2026-04-05T10:00:00.000Z"},{"id":"64f1a2b3c4d5e6f7a8b9c0e2","taskId":"64f1a2b3c4d5e6f7a8b9c0d1","organizationId":"63415bf67a9c7000126616c1","ownerId":"507f1f77bcf86cd799439011","eventType":"failed","errorMessage":"Content minutes limit reached","createdAt":"2026-04-04T10:00:00.000Z"}],"links":{"next":null,"total":2}}}}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Task not found or deleted.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["content-autopilot"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//events' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function listTaskEvents() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//events', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//content-autopilot//events\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/drops":{"get":{"operationId":"OrganizationDropsApi_getOrganizationDrops","summary":"List organization social drops","description":"\n## Organization Social Drops\n\nRetrieves paginated list of ready social drops for your organization. A drop is a publish-ready package (video variants, covers, copy packs) linked to an Exercise, Collection (Micro Workout), Workout, or Program.\n\n**Note:** Only drops with status `ready` are returned. Draft, processing, and failed drops are excluded.\n\n---\n\n### Access and Auth\n\n- **Auth:** API key (X-Api-Key header)\n- **Scope:** Organization (organizationId)\n- **Capabilities:** List ready drops, get drop detail, export channel bundle (video, cover, copy pack)\n\n---\n\n### Use Cases\n\n- **Social scheduling tools** - List drops for content calendar\n- **Content management dashboards** - Browse and export ready assets\n- **Bulk export workflows** - Get video + cover + copy for channel publishing\n- **Channel-specific discovery** - Filter by aspect ratio and duration\n\n---\n\n### Filtering and Pagination\n\n**Filters:**\n- `sourceType` - exercise, exerciseCollection, workout, workoutCollection\n- `sourceId` - Filter by source entity ID (use with sourceType for entity-context views)\n- `aspectRatio` - 9:16, 1:1, 16:9 (drops that have this variant)\n- `duration` - 15, 30, 60 (seconds; drops that have this variant)\n- `q` - Search by drop title (min 3 characters)\n\n**Sort:** Use `sort` with +field (asc) or -field (desc), e.g. `-updatedAt`, `+createdAt`\n\n**Pagination:**\n- `limit` - Items per page (default: 20, max: 50)\n- `offset` - Pagination offset (default: 0)\n\n---\n\n### Best Practices\n\n- **Cache responses** - Drops change when new content is published\n- **Use sourceId** - Filter by source when showing drops in entity-context modals\n- **Handle empty results** - Graceful fallback when no ready drops exist\n\n---\n\n### Related Endpoints\n\n- Get Drop: `GET /v1/orgs/{orgId}/drops/{dropId}` - Full detail with variants and copy packs\n- Export Drop: `POST /v1/orgs/{orgId}/drops/{dropId}/export` - Channel bundle (video, cover, copy)\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Items per page. Defaults to 20, max 50.","example":20,"schema":{"minimum":1,"maximum":50,"default":20,"type":"number"}},{"name":"q","required":false,"in":"query","description":"Search by drop title (min 3 characters)","schema":{"type":"string"}},{"name":"sort","required":false,"in":"query","description":"Sort: +updatedAt, -createdAt","schema":{"type":"string"}},{"name":"sourceType","required":false,"in":"query","description":"Filter by source type","schema":{"enum":["exercise","exerciseCollection","workout","workoutCollection"],"type":"string"}},{"name":"sourceId","required":false,"in":"query","description":"Filter by source entity ID","schema":{"type":"string"}},{"name":"aspectRatio","required":false,"in":"query","description":"Filter by aspect ratio","schema":{"enum":["9:16","1:1","16:9"],"type":"string"}},{"name":"duration","required":false,"in":"query","description":"Filter by duration in seconds","schema":{"enum":[15,30,60],"type":"number"}},{"name":"offset","required":false,"in":"query","description":"Pagination offset. Defaults to 0.","example":0,"schema":{"type":"number"}}],"responses":{"200":{"description":"Successfully retrieved paginated list of ready drops for the organization.","content":{"application/json":{"examples":{"default":{"summary":"List of ready drops","value":{"data":[{"id":"64f1a2b3c4d5e6f7a8b9c0d1","organizationId":"63415bf67a9c7000126616c1","sourceType":"exercise","sourceId":"507f1f77bcf86cd799439011","sourceName":"Jumping Jacks","title":"Jumping Jacks","sourceThumbnailUrl":"https://hhcontent.s3.eu-central-1.amazonaws.com/...","sourceTypeLabel":"Exercise","locale":"en-US","channelPreset":"ig_reels","channelPresetLabel":"Instagram Reels","availableVariants":["9:16_30000","9:16_15000","1:1_30000"],"createdAt":"2025-09-15T10:30:00Z","updatedAt":"2025-09-16T14:20:00Z"},{"id":"64f1a2b3c4d5e6f7a8b9c0d2","organizationId":"63415bf67a9c7000126616c1","sourceType":"workout","sourceId":"12ab3efd45c67c1234566cd1","sourceName":"Morning Power HIIT","title":"Morning Power HIIT","sourceThumbnailUrl":"https://hhcontent.s3.eu-central-1.amazonaws.com/...","sourceTypeLabel":"Workout","locale":"en-US","channelPreset":"ig_reels","channelPresetLabel":"Instagram Reels","availableVariants":["9:16_60000","1:1_30000"],"createdAt":"2025-09-14T08:00:00Z","updatedAt":"2025-09-15T11:45:00Z"}],"links":{"next":"https://content.api.hyperhuman.cc/v1/orgs/63415bf67a9c7000126616c1/drops?limit=20&offset=20","total":42},"explanation":"Your ready social drops - video variants, covers, and copy packs for channel publishing."}}}}}},"400":{"description":"Invalid filter or pagination parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//drops' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getOrganizationDrops() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//drops', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//drops\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/drops/{dropId}":{"get":{"operationId":"OrganizationDropsApi_getOrganizationDropById","summary":"Get drop by ID","description":"\n## Drop Detail\n\nReturns full drop detail including video variants with presigned download and poster URLs, and copy packs per channel.\n\n**Response structure:**\n- `copyPack` - Copy pack for the default channel (channelPreset)\n- `copyPacks` - Copy packs per channel; use `copyPacks[viewChannel] ?? copyPack` for channel switching\n- `variants` - Video variants with aspectRatio, duration, downloadLink, posterLink, posterLinksByChannel, size\n\n**URL expiration:** Presigned URLs are valid for 7 days.\n\n---\n\n### Related Endpoints\n\n- List Drops: `GET /v1/orgs/{orgId}/drops` - Browse organization drops\n- Export Drop: `POST /v1/orgs/{orgId}/drops/{dropId}/export` - Get channel bundle\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"dropId","required":true,"in":"path","description":"The unique identifier of the drop.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved drop detail.","content":{"application/json":{"examples":{"default":{"summary":"Drop detail with variants and copy packs","value":{"id":"64f1a2b3c4d5e6f7a8b9c0d1","organizationId":"63415bf67a9c7000126616c1","sourceType":"exercise","sourceId":"507f1f77bcf86cd799439011","sourceName":"Jumping Jacks","title":"Jumping Jacks","sourceThumbnailUrl":"https://hhcontent.s3.eu-central-1.amazonaws.com/...","sourceTypeLabel":"Exercise","locale":"en-US","channelPreset":"ig_reels","channelPresetLabel":"Instagram Reels","availableVariants":["9:16_30000","9:16_15000","1:1_30000"],"copyPack":{"hook":"Get fit in 30 seconds!","caption":"30 seconds of Jumping Jacks to get your heart pumping. Perfect for a quick warm-up or standalone cardio burst. Try it now and feel the burn.","hashtags":"#fitness #workout #hiit #cardio","cta":"Link in bio","posterTagline":{"primaryLine":"30s HIIT","secondaryLine":"Jumping Jacks"}},"copyPacks":{"ig_reels":{"hook":"Get fit in 30 seconds!","caption":"30 seconds of Jumping Jacks to get your heart pumping. Perfect for a quick warm-up or standalone cardio burst. Try it now and feel the burn.","hashtags":"#fitness #workout #hiit #cardio","cta":"Link in bio","posterTagline":{"primaryLine":"30s HIIT","secondaryLine":"Jumping Jacks"}},"tiktok":{"hook":"30 sec cardio burst","caption":"Jumping Jacks - no equipment needed. Drop a heart if you finished it.","hashtags":"#fitness #workout #cardio #30secondchallenge","cta":"Full workout in bio","posterTagline":{"primaryLine":"30s HIIT","secondaryLine":"Jumping Jacks"}}},"variants":[{"aspectRatio":"9:16","duration":30000,"downloadLink":"https://hhcontent.s3.../drop_9x16_30.mp4?X-Amz-...","posterLink":"https://hhcontent.s3.../poster.png?X-Amz-...","posterLinksByChannel":{"tiktok":"https://hhcontent.s3.../poster_tiktok.png?X-Amz-..."},"size":1234567},{"aspectRatio":"9:16","duration":15000,"downloadLink":"https://hhcontent.s3.../drop_9x16_15.mp4?X-Amz-...","posterLink":"https://hhcontent.s3.../poster_15.png?X-Amz-...","size":654321},{"aspectRatio":"1:1","duration":30000,"downloadLink":"https://hhcontent.s3.../drop_1x1_30.mp4?X-Amz-...","posterLink":"https://hhcontent.s3.../poster_1x1.png?X-Amz-...","size":987654}],"createdAt":"2025-09-15T10:30:00Z","updatedAt":"2025-09-16T14:20:00Z"}}}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Drop not found or not ready.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//drops/' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getOrganizationDropById() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//drops/', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//drops/\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/drops/{dropId}/export":{"post":{"operationId":"OrganizationDropsApi_exportDrop","summary":"Export drop for channel bundle","description":"\n## Export for Channel Bundle\n\nReturns presigned video download URL, cover image URL, and copy pack for the specified channel. Use for one-click export to Reels, Shorts, TikTok, etc.\n\n**Response contents:**\n- `videoDownloadLink` - Presigned S3 URL for MP4 video (valid 7 days)\n- `coverLink` - Presigned S3 URL for cover/poster image\n- `copyPack` - Hook, caption, hashtags, CTA, poster tagline\n- `ctaUrl` - Optional CTA URL from team settings (when configured)\n\n**Channel presets:** ig_reels, ig_stories, ig_carousel, tiktok, yt_shorts, fb_reels, yt_longform. Each has default aspect ratio and duration; override via body.\n\n---\n\n### Integration Example\n\n```javascript\nconst res = await fetch(\n `/v1/orgs/${orgId}/drops/${dropId}/export`,\n {\n method: 'POST',\n headers: {\n 'X-Api-Key': apiKey,\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({ channelPreset: 'ig_reels' }),\n }\n);\nconst { videoDownloadLink, coverLink, copyPack } = await res.json();\n// Download video, copy caption to clipboard\n```\n\n---\n\n### Best Practices\n\n- **Refresh URLs before expiry** - Presigned URLs valid for 7 days\n- **Use channel preset** - Platform-specific defaults (aspect ratio, duration)\n- **Handle 400** - Requested variant may not be available for this drop\n\n---\n\n### Related Endpoints\n\n- Get Drop: `GET /v1/orgs/{orgId}/drops/{dropId}` - Full detail before export\n- List Drops: `GET /v1/orgs/{orgId}/drops` - Browse organization drops\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"dropId","required":true,"in":"path","description":"The unique identifier of the drop.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"requestBody":{"required":false,"description":"Optional overrides. Omit to use drop defaults.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportDropDto"},"examples":{"default":{"summary":"Use drop defaults","value":{}},"igReels":{"summary":"Instagram Reels","value":{"channelPreset":"ig_reels"}},"customVariant":{"summary":"Custom variant","value":{"channelPreset":"tiktok","aspectRatio":"9:16","duration":15}}}}}},"responses":{"200":{"description":"Channel bundle with presigned URLs and copy pack.","content":{"application/json":{"examples":{"default":{"summary":"Export bundle for Instagram Reels","value":{"videoDownloadLink":"https://hhcontent.s3.../drop_9x16_30.mp4?X-Amz-...","coverLink":"https://hhcontent.s3.../cover.png?X-Amz-...","ctaUrl":"https://mybrand.com/fitness","copyPack":{"hook":"Get fit in 30 seconds!","caption":"30 seconds of Jumping Jacks to get your heart pumping. Perfect for a quick warm-up or standalone cardio burst. Try it now and feel the burn.","hashtags":"#fitness #workout #hiit","cta":"Link in bio","posterTagline":{"primaryLine":"30s HIIT","secondaryLine":"Jumping Jacks"}}}}}}}},"400":{"description":"Requested variant not available for this drop.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Authentication failed - API key is missing or invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"API key is not authorized for this organization.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Drop not found or not ready.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//drops//export' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function exportDrop() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//drops//export', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\n \"https://content.api.hyperhuman.cc/v1/orgs//drops//export\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/social-publish/connected-platforms":{"get":{"operationId":"OrganizationSocialPublishApi_getConnectedPlatforms","summary":"List connected social platforms","description":"Returns which platforms (instagram, tiktok, youtube, facebook) have a stored account id for this organization. Account connection is managed in the Hyperhuman team app, not via this API.","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationConnectedPlatformsResponseDto"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social-publish"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//social-publish/connected-platforms' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getConnectedPlatforms() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//social-publish/connected-platforms', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//social-publish/connected-platforms\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/social-publish":{"get":{"operationId":"OrganizationSocialPublishApi_listTasks","summary":"List scheduled social publish automations","description":"\n## List social publish tasks\n\nPaginated scheduled social-publish automations for this organization (`{ data, links }`).\n\n**Try it:** `GET /v1/orgs/{organizationId}/social-publish?limit=20` with `X-Api-Key`. Optional `status` (`active` | `draft`). Pagination: `limit` (default **20**, max **50**); advance via `links.next`.\n\n**Related:** `GET .../social-publish/connected-platforms`, `POST .../social-publish`, `PATCH .../social-publish/{taskId}`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"limit","required":false,"in":"query","description":"Maximum number of items to return per page.","example":20,"schema":{"minimum":1,"maximum":50,"default":20,"type":"number"}},{"name":"offset","required":false,"in":"query","description":"Number of items to skip before collecting results (zero-based). Prefer the `links.next` cursor for pagination.","example":0,"schema":{"minimum":0,"default":0,"type":"number"}},{"name":"status","required":false,"in":"query","description":"Filter by task status","schema":{"enum":["active","draft"],"type":"string"}},{"name":"sourceMode","required":false,"in":"query","description":"Filter by source mode","schema":{"enum":["manual_fixed","random_ready","ai_insights","ai_pick"],"type":"string"}},{"name":"sortBy","required":false,"in":"query","description":"Sort by field","schema":{"enum":["updatedAt","createdAt"],"type":"string"}},{"name":"sortOrder","required":false,"in":"query","description":"Sort order","schema":{"enum":["ascend","descend"],"type":"string"}},{"name":"search","required":false,"in":"query","description":"Case-insensitive substring match on automation name (min 1 character after trim)","schema":{"maxLength":200,"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSocialPublishTaskListResponse"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social-publish"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//social-publish' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function listTasks() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//social-publish', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//social-publish\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]},"post":{"operationId":"OrganizationSocialPublishApi_createTask","summary":"Create a social publish automation (draft)","description":"\n## Create a social publish task\n\nCreates a social-publish automation as **draft** (**201**). Body matches the team internal create-social-publish task shape. OAuth connect, run-now, and per-run event listing are **not** on Content API — use the team app / internal routes.\n\n**Next:** `PATCH .../social-publish/{taskId}` with `{ \"status\": \"active\" }` to schedule (requires connected accounts for target platforms; otherwise **422**).\n\n**Related:** `GET .../social-publish/connected-platforms`, `GET .../social-publish`, `PATCH .../social-publish/{taskId}`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSocialDropPublishTaskDto"}}}},"responses":{"201":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSocialPublishTaskResponseDto"}}}},"403":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social-publish"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X POST 'https://content.api.hyperhuman.cc/v1/orgs//social-publish' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function createTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//social-publish', {\n method: 'POST',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.post(\n \"https://content.api.hyperhuman.cc/v1/orgs//social-publish\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/orgs/{organizationId}/social-publish/{taskId}":{"get":{"operationId":"OrganizationSocialPublishApi_getTask","summary":"Get one social publish automation","description":"\n## Get a social publish task\n\nReturns one automation by `taskId` for this organization (includes schedule fields and last-run outcome when present). **404** if missing or not owned by the org.\n\n**Related:** `GET .../social-publish`, `PATCH .../social-publish/{taskId}`, `DELETE .../social-publish/{taskId}`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the scheduled social publish automation.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSocialPublishTaskResponseDto"}}}},"404":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social-publish"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X GET 'https://content.api.hyperhuman.cc/v1/orgs//social-publish/' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function getTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//social-publish/', {\n method: 'GET',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.get(\"https://content.api.hyperhuman.cc/v1/orgs//social-publish/\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]},"patch":{"operationId":"OrganizationSocialPublishApi_patchTask","summary":"Update a social publish automation","description":"\n## Update a social publish task\n\nPartial update. `status: active` schedules the task (requires connected accounts for all target platforms; missing accounts / posting base URL → **422**). `status: draft` pauses and clears `nextRunAt`. Other fields follow the same rules as the team internal API.\n\n**Related:** `GET .../social-publish/connected-platforms`, `GET .../social-publish/{taskId}`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the scheduled social publish automation.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationPatchSocialPublishTaskDto"}}}},"responses":{"200":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrganizationSocialPublishTaskResponseDto"}}}},"422":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"tags":["social-publish"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X PATCH 'https://content.api.hyperhuman.cc/v1/orgs//social-publish/' \\\n -H 'X-Api-Key: YOUR_API_KEY' \\\n -H 'Content-Type: application/json' \\\n -d '{}'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function patchTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//social-publish/', {\n method: 'PATCH',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n 'Content-Type': 'application/json',\n },\n body: JSON.stringify({}),\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.patch(\n \"https://content.api.hyperhuman.cc/v1/orgs//social-publish/\",\n headers={**headers, \"Content-Type\": \"application/json\"},\n json={},\n)\nresponse.raise_for_status()\nprint(response.json())"}]},"delete":{"operationId":"OrganizationSocialPublishApi_deleteTask","summary":"Delete a social publish automation (soft delete)","description":"\n## Delete a social publish task\n\nSoft-deletes the automation (**204**). Cron will not pick it up afterward; an in-flight run may still finish.\n\n**Related:** `GET .../social-publish`, `PATCH .../social-publish/{taskId}`.\n ","parameters":[{"name":"organizationId","required":true,"in":"path","description":"The unique identifier of the organization.","example":"63415bf67a9c7000126616c1","schema":{"type":"string"}},{"name":"taskId","required":true,"in":"path","description":"The unique identifier of the scheduled social publish automation.","example":"64f1a2b3c4d5e6f7a8b9c0d1","schema":{"type":"string"}}],"responses":{"204":{"description":""}},"tags":["social-publish"],"security":[{"X-Api-Key":["X-Api-Key"]}],"x-codeSamples":[{"lang":"curl","label":"cURL","source":"curl -X DELETE 'https://content.api.hyperhuman.cc/v1/orgs//social-publish/' \\\n -H 'X-Api-Key: YOUR_API_KEY'"},{"lang":"typescript","label":"TypeScript (fetch)","source":"async function deleteTask() {\n const res = await fetch('https://content.api.hyperhuman.cc/v1/orgs//social-publish/', {\n method: 'DELETE',\n headers: {\n 'X-Api-Key': process.env.HYPERHUMAN_API_KEY ?? '',\n },\n });\n if (!res.ok) {\n const err = await res.json().catch(() => ({}));\n throw new Error(err.error?.code ?? res.statusText);\n }\n return res.json();\n}"},{"lang":"python","label":"Python (requests)","source":"import os\nimport requests\n\nheaders = {\"X-Api-Key\": os.environ[\"HYPERHUMAN_API_KEY\"]}\nresponse = requests.delete(\"https://content.api.hyperhuman.cc/v1/orgs//social-publish/\", headers=headers)\nresponse.raise_for_status()\nprint(response.json())"}]}},"/v1/workouts/{workoutId}/playlist":{"get":{"operationId":"WorkoutContentApi_getWorkoutPlaylist","summary":"Retrieve Detailed Workout Playlist Structure","description":"\n## Workout playlist\n\nOrdered playback segments for a **persisted** workout id. Response: `{ data, presentationStyle?, links? }` where `data` is an array of **single-key** objects keyed by segment kind (`intro`, `exercise`, `multiExercise`, `class`, `promo`, `educational`, `break`, `outro`). Not the AI-generate `instances[]` shape.\n\n**Try it:** `GET /v1/workouts/{workoutId}/playlist` with `X-Api-Key`. Optional `locale` (BCP-47) localizes segment names, equipment, muscle groups, and audio selection (unsupported → English fallback).\n\n**Segments:** `exercise` has timing/prescription + `main.video` / instruction audio (`url`, optional `type` / `locale` / `scriptText`). `class` may include optional `chapters[]` (`startTimeSec` / `endTimeSec` within `main.video`) when analysis ran; chapter text is not re-localized. `multiExercise` is the original-audio block kind (still emitted when present).\n\n**Media:** Video and audio `url` values are time-limited AWS S3 **presigned HTTPS** links to **progressive MP4** / M4A (typically ~**7 days**). Re-fetch the playlist before expiry; do not treat URLs as durable. Not HLS/DASH/ABR — play with HTML5 `