{"info":{"contact":{"email":"support@jellypod.com","name":"Jellypod Support","url":"https://docs.jellypod.com/api"},"description":"Programmatic access to Jellypod podcasts, episodes, hosts, sources, and voices.","license":{"name":"Proprietary"},"title":"Jellypod API","version":"1.0.0"},"openapi":"3.1.0","servers":[{"description":"Production","url":"https://api.jellypod.com"},{"description":"Local development","url":"http://localhost:3003"}],"tags":[{"description":"Service liveness checks.","name":"Health"},{"description":"Authenticated organization details.","name":"Account"},{"description":"Podcast resources.","name":"Podcasts"},{"description":"Episode resources.","name":"Episodes"},{"description":"Streaming and playback metrics for podcasts and episodes.","name":"Analytics"},{"description":"Host (speaker) resources.","name":"Hosts"},{"description":"Source documents fed to generation.","name":"Sources"},{"description":"Video generation resources.","name":"Videos"},{"description":"Short generation resources.","name":"Shorts"},{"description":"Voiceover generation resources.","name":"Voiceovers"},{"description":"TTS voices.","name":"Voices"}],"components":{"securitySchemes":{"bearerAuth":{"description":"API key issued from /settings/api-keys in the Jellypod studio. Send as `Authorization: Bearer <key>`.","scheme":"bearer","type":"http"}},"schemas":{"ApiIndex":{"type":"object","properties":{"authentication":{"type":"object","properties":{"documentation_url":{"type":"string","format":"uri"},"header":{"type":"string"},"keys_url":{"type":"string","format":"uri"},"type":{"type":"string","enum":["bearer"]}},"required":["documentation_url","header","keys_url","type"]},"description":{"type":"string"},"developers_url":{"type":"string","format":"uri"},"documentation_url":{"type":"string","format":"uri"},"errors":{"type":"object","properties":{"format":{"type":"string","enum":["application/problem+json"]},"specification":{"type":"string","format":"uri"}},"required":["format","specification"]},"llms_txt_url":{"type":"string","format":"uri"},"mcp":{"type":"object","properties":{"documentation_url":{"type":"string","format":"uri"},"server_card_url":{"type":"string","format":"uri"},"transport":{"type":"string","enum":["streamable-http"]},"url":{"type":"string","format":"uri"}},"required":["documentation_url","server_card_url","transport","url"]},"name":{"type":"string"},"openapi_url":{"type":"string","format":"uri"},"version":{"type":"string"}},"required":["authentication","description","developers_url","documentation_url","errors","llms_txt_url","mcp","name","openapi_url","version"],"description":"Discovery document linking the OpenAPI spec, docs, authentication, and MCP server."},"Account":{"type":"object","properties":{"data":{"type":"object","properties":{"organization_id":{"type":"string","readOnly":true},"plan":{"type":"string","readOnly":true},"credits":{"type":"object","properties":{"balance":{"type":"number","readOnly":true}},"required":["balance"]}},"required":["organization_id","plan","credits"]}},"required":["data"],"description":"Caller organization, current plan, and credit balance."},"ApiError":{"type":"object","properties":{"detail":{"type":"string","description":"Longer human-readable explanation when available."},"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}},"required":["field","message"]},"description":"Per-field validation failures. Present when `type` is `validation_error`."},"reason":{"type":"string","enum":["unresolved_speakers"],"description":"Script import failure when one or more Speakers have no saved Character match."},"recovery":{"type":"object","properties":{"action":{"type":"string","enum":["correct_input","choose_characters","check_account","poll_content","open_studio","check_content","reconnect","retry","check_result"]},"idempotency_key":{"type":"string","enum":["reuse","new"]},"poll_after_seconds":{"type":"number","minimum":0},"tool":{"type":"string","enum":["list_characters","list_content","get_content","save_podcast"]}},"required":["action"]},"request_id":{"type":"string","description":"Correlation id, also returned in the `X-Request-Id` response header. Include in support requests."},"speakers":{"type":"array","items":{"type":"string"},"description":"Speaker labels needing a saved Character match when reason is unresolved_speakers."},"status":{"type":"integer","description":"HTTP status code mirrored from the response."},"title":{"type":"string","description":"Short human-readable summary."},"type":{"type":"string","enum":["bad_request","validation_error","unauthorized","forbidden","not_found","conflict","method_not_allowed","unsupported_media_type","unprocessable_entity","rate_limited","bad_gateway","internal_error"],"description":"Machine-readable error class. Suitable for switch/match in client code."}},"required":["status","title","type"],"description":"RFC 9457 error envelope returned for all non-2xx responses from the Jellypod API."},"EpisodeAnalytics":{"type":"object","properties":{"downloads":{"$ref":"#/components/schemas/EpisodeDownloads"},"video_views":{"$ref":"#/components/schemas/EpisodeVideoViews"},"as_of":{"type":"string","description":"ISO-8601 time these metrics were computed.","readOnly":true},"complete":{"type":"boolean","description":"Whether every analytics source answered in full. When false an upstream (OP3 or Mux) was degraded, so the numbers are a floor rather than a total; retry later for a complete read.","readOnly":true},"episode_id":{"type":"string","format":"uuid","readOnly":true}},"required":["downloads","video_views","as_of","complete","episode_id"],"description":"Streaming metrics for a single episode. Audio download windows are measured since publish; video view windows are rolling."},"EpisodeDownloads":{"type":"object","properties":{"first_7_days":{"type":"number","minimum":0,"description":"Audio downloads in the first 7 days after publish."},"first_30_days":{"type":"number","minimum":0,"description":"Audio downloads in the first 30 days after publish."},"total":{"type":"number","minimum":0,"description":"All-time audio downloads (OP3)."}},"required":["first_7_days","first_30_days","total"]},"EpisodeVideoViews":{"type":"object","properties":{"last_7_days":{"type":"number","minimum":0,"description":"Web video views in the last 7 days."},"last_30_days":{"type":"number","minimum":0,"description":"Web video views in the last 30 days."},"total":{"type":"number","minimum":0,"description":"Web video views over the last 90 days (Mux retention window)."}},"required":["last_7_days","last_30_days","total"]},"PodcastAnalytics":{"type":"object","properties":{"analytics_enabled":{"type":"boolean","description":"Whether download tracking is enabled. When false, audio metrics are 0."},"as_of":{"type":"string","description":"ISO-8601 time these metrics were computed.","readOnly":true},"complete":{"type":"boolean","description":"Whether every analytics source answered in full. When false an upstream (OP3 or Mux) was degraded, so the numbers are a floor rather than a total; retry later for a complete read.","readOnly":true},"episodes":{"type":"array","items":{"type":"object","properties":{"downloads":{"type":"object","properties":{"first_7_days":{"type":"number","minimum":0,"description":"Audio downloads in the first 7 days after publish."},"first_30_days":{"type":"number","minimum":0,"description":"Audio downloads in the first 30 days after publish."},"total":{"type":"number","minimum":0,"description":"All-time audio downloads (OP3)."}},"required":["first_7_days","first_30_days","total"]},"video_views":{"type":"object","properties":{"last_7_days":{"type":"number","minimum":0,"description":"Web video views in the last 7 days."},"last_30_days":{"type":"number","minimum":0,"description":"Web video views in the last 30 days."},"total":{"type":"number","minimum":0,"description":"Web video views over the last 90 days (Mux retention window)."}},"required":["last_7_days","last_30_days","total"]},"episode_id":{"type":"string","format":"uuid","readOnly":true}},"required":["downloads","video_views","episode_id"]}},"plays_by_app":{"type":"object","additionalProperties":{"type":"number","minimum":0},"description":"Audio downloads grouped by client app (Spotify, Apple Podcasts, Overcast, ...). Show-level."},"podcast_id":{"type":"string","format":"uuid","readOnly":true},"totals":{"type":"object","properties":{"downloads":{"type":"number","minimum":0,"description":"All-time audio downloads (OP3)."},"last_7_days":{"type":"number","minimum":0,"description":"Combined plays in the last 7 days."},"last_30_days":{"type":"number","minimum":0,"description":"Combined plays in the last 30 days."},"plays":{"type":"number","minimum":0,"description":"All-time audio downloads + web video views."},"video_views":{"type":"number","minimum":0,"description":"Web video views (Mux, last 90 days)."}},"required":["downloads","last_7_days","last_30_days","plays","video_views"]}},"required":["analytics_enabled","as_of","complete","episodes","plays_by_app","podcast_id","totals"],"description":"Streaming metrics for a podcast: combined totals, per-app download breakdown, and per-episode metrics."},"ListEpisodesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Episode"}}},"required":["data"],"description":"Page of episodes. Use the `Link` response header (`rel=\"next\"`) to paginate."},"Episode":{"type":"object","properties":{"audio_url":{"type":["string","null"],"readOnly":true},"created_at":{"type":"string","readOnly":true},"description":{"type":["string","null"]},"generation":{"type":["object","null"],"properties":{"completed_at":{"type":["string","null"]},"error_message":{"type":"string"},"started_at":{"type":"string"},"state":{"type":"string","enum":["generating","completed","failed"]},"skipped_sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":["string","null"]},"url":{"type":["string","null"]},"reason":{"type":"string"}},"required":["id","title","url","reason"]}}},"required":["completed_at","started_at","state"],"readOnly":true},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid","readOnly":true},"image_url":{"type":["string","null"]},"podcast_id":{"type":"string","format":"uuid"},"published_at":{"type":["string","null"],"readOnly":true},"scheduled_at":{"type":["string","null"],"readOnly":true},"source_ids":{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true},"status":{"$ref":"#/components/schemas/EpisodeStatus"},"title":{"type":["string","null"]},"updated_at":{"type":"string","readOnly":true},"url":{"type":["string","null"],"readOnly":true},"video_url":{"type":["string","null"],"readOnly":true}},"required":["audio_url","created_at","description","generation","host_ids","id","image_url","podcast_id","published_at","scheduled_at","source_ids","status","title","updated_at","url","video_url"],"description":"A podcast episode with publishing metadata and (when available) audio/video URLs."},"EpisodeStatus":{"type":"string","enum":["draft","published","scheduled"],"description":"Lifecycle state stored on the episode row. Generation progress is reported separately on the `generation` field, `generating`/`completed`/`failed` are not `status` values.","readOnly":true},"CreateEpisodeInput":{"type":"object","properties":{"description":{"type":"string","maxLength":2000},"host_ids":{"type":"array","items":{"type":"string"}},"image":{"type":"string","format":"uri"},"podcast_id":{"type":"string","format":"uuid","description":"Podcast that will own the new episode."},"title":{"type":"string","minLength":1,"maxLength":255}},"required":["podcast_id"],"additionalProperties":false,"description":"Fields for creating an empty episode row. No content is generated."},"AcceptedEpisodeResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"created_at":{"type":"string"},"host_ids":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"podcast_id":{"type":"string"},"status":{"type":"string","enum":["generating"]},"updated_at":{"type":"string"},"workflow_run_id":{"type":"string"}},"required":["created_at","host_ids","id","podcast_id","status","updated_at","workflow_run_id"]}},"required":["data"],"description":"Acknowledgement for an asynchronously-generated episode."},"GenerateEpisodeInput":{"type":"object","properties":{"host_ids":{"type":"array","items":{"type":"string"},"description":"Hosts to use for generation. In script mode, every segment host_id must be included here, or omit host_ids to infer them from the script.","example":["2e6939fe","a91c4d22"]},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"options":{"type":"object","properties":{"episode_length":{"type":"string"},"episode_length_minutes":{"type":"integer","minimum":1,"maximum":75},"web_search":{"type":"boolean"}},"default":{},"description":"Prompt-mode generation options. These are not used when `script` is provided."},"prompt":{"type":"string","minLength":10,"maxLength":10000,"description":"Prompt used to write the episode script. Omit it to write the episode from `source_ids` alone. Provide `prompt`, `source_ids`, or both, or `script` instead.","example":"Create a friendly two-host episode about simple habits for a calmer workweek."},"script":{"$ref":"#/components/schemas/ImportedEpisodeScript"},"source_ids":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Source documents for prompt-based generation. Not supported when `script` is provided."},"podcast_id":{"type":"string","format":"uuid","description":"Podcast that will own the generated episode."},"outputs":{"type":"array","items":{"type":"string","enum":["audio","video"]},"maxItems":2,"description":"Files to produce: audio (MP3), video (MP4 with sound), both, or [] for an editable draft. Each requested file becomes downloadable independently. Do not combine with render. Omission preserves legacy render behavior."},"render":{"type":"boolean","description":"Deprecated: use outputs. True produces audio and video; false or omission leaves an editable draft. Do not combine with outputs.","deprecated":true}},"required":["podcast_id"],"additionalProperties":false,"description":"Fields for generating a new episode asynchronously. Prompt mode always writes a new script from the supplied material. Use POST /v1/episodes/import to preserve script text, or script mode here for a validated structured script."},"ImportedEpisodeScript":{"type":"object","properties":{"chapters":{"type":"array","items":{"$ref":"#/components/schemas/ImportedScriptChapter"},"minItems":1,"maxItems":50,"description":"Ordered script chapters. Maximum 50 chapters."}},"required":["chapters"],"additionalProperties":false,"description":"Structured script input for episode generation. Script mode skips prompt-based script writing. Limits: 75000 total text characters, 50 chapters, 200 segments per chapter, 600 total segments, and 5000 characters per segment.","example":{"chapters":[{"segments":[{"host_id":"2e6939fe","text":"Welcome to the show. Today we are talking about one small habit that can make the week easier."},{"host_id":"a91c4d22","text":"I like that. Let us start with something simple someone can try tomorrow morning."}],"title":"Opening"}]}},"ImportedScriptChapter":{"type":"object","properties":{"segments":{"type":"array","items":{"$ref":"#/components/schemas/ImportedScriptSegment"},"minItems":1,"maxItems":200,"description":"Spoken turns in this chapter. Maximum 200 segments."},"title":{"type":"string","minLength":1,"maxLength":200,"description":"Optional chapter title.","example":"Opening"}},"required":["segments"],"additionalProperties":false,"description":"A group of imported script segments. Each chapter can contain up to 200 segments.","example":{"segments":[{"host_id":"2e6939fe","text":"Welcome to the show. Today we are talking about one small habit that can make the week easier."},{"host_id":"a91c4d22","text":"I like that. Let us start with something simple someone can try tomorrow morning."}],"title":"Opening"}},"ImportedScriptSegment":{"type":"object","properties":{"host_id":{"type":"string","minLength":1,"description":"Host ID for the speaker of this segment.","example":"2e6939fe"},"text":{"type":"string","minLength":1,"maxLength":5000,"description":"Text to synthesize for this segment. Maximum 5000 characters.","example":"Welcome to the show. Today we are talking about one small habit that can make the week easier."}},"required":["host_id","text"],"additionalProperties":false,"description":"One spoken turn in an imported script. The host must belong to your organization.","example":{"host_id":"2e6939fe","text":"Welcome to the show. Today we are talking about one small habit that can make the week easier."}},"ImportEpisodeInput":{"type":"object","properties":{"podcast_id":{"type":"string","format":"uuid","description":"Podcast that will own the imported generated episode."},"outputs":{"type":"array","items":{"type":"string","enum":["audio","video"]},"maxItems":2,"description":"Files to produce: audio (MP3), video (MP4 with sound), both, or [] for an editable draft. Each requested file becomes downloadable independently. Do not combine with render. Omission preserves legacy render behavior."},"render":{"type":"boolean","description":"Deprecated: use outputs. True produces audio and video; false or omission leaves an editable draft. Do not combine with outputs.","deprecated":true},"script":{"type":"string","minLength":1,"maxLength":75000,"description":"Script or transcript text. Bracketed speaker labels match saved Characters unless speaker_characters explicitly assigns their Character IDs.","example":"[Host One]\nWelcome to the show. Today we are talking about one small habit that can make the week easier.\n\n[Host Two]\nI like that. Let us start with something simple someone can try tomorrow morning."},"speaker_characters":{"type":"array","items":{"type":"object","properties":{"character_id":{"type":"string","minLength":1},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["character_id","label"],"additionalProperties":false},"minItems":1,"maxItems":200,"description":"Optional explicit assignments for a finished script: label as written in [brackets], and character_id from list_characters. Assignments override name matching; unmapped labels still match saved Character names."}},"required":["podcast_id","script"],"additionalProperties":false,"description":"Fields for importing script or transcript text and generating a new episode asynchronously."},"UpdateEpisodeInput":{"type":"object","properties":{"description":{"type":["string","null"],"maxLength":2000},"image":{"type":["string","null"],"format":"uri"},"title":{"type":"string","minLength":1,"maxLength":255}},"additionalProperties":false,"description":"Patchable episode fields. All optional; only provided fields are updated."},"EpisodeDetail":{"type":"object","properties":{"audio_url":{"type":["string","null"],"readOnly":true},"created_at":{"type":"string","readOnly":true},"description":{"type":["string","null"]},"generation":{"type":["object","null"],"properties":{"completed_at":{"type":["string","null"]},"error_message":{"type":"string"},"started_at":{"type":"string"},"state":{"type":"string","enum":["generating","completed","failed"]},"skipped_sources":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":["string","null"]},"url":{"type":["string","null"]},"reason":{"type":"string"}},"required":["id","title","url","reason"]}}},"required":["completed_at","started_at","state"],"readOnly":true},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid","readOnly":true},"image_url":{"type":["string","null"]},"podcast_id":{"type":"string","format":"uuid"},"published_at":{"type":["string","null"],"readOnly":true},"scheduled_at":{"type":["string","null"],"readOnly":true},"source_ids":{"type":"array","items":{"type":"string","format":"uuid"},"readOnly":true},"status":{"$ref":"#/components/schemas/EpisodeStatus"},"title":{"type":["string","null"]},"updated_at":{"type":"string","readOnly":true},"url":{"type":["string","null"],"readOnly":true},"video_url":{"type":["string","null"],"readOnly":true},"outputs":{"type":"object","properties":{"audio":{"type":"object","properties":{"current":{"type":"boolean"},"download_url":{"type":["string","null"],"format":"uri"},"error":{"type":["string","null"]},"status":{"type":"string","enum":["not_requested","preparing","available","failed"]}},"required":["current","download_url","error","status"]},"video":{"type":"object","properties":{"current":{"type":"boolean"},"download_url":{"type":["string","null"],"format":"uri"},"error":{"type":["string","null"]},"status":{"type":"string","enum":["not_requested","preparing","available","failed"]}},"required":["current","download_url","error","status"]}},"required":["audio","video"]},"progress":{"$ref":"#/components/schemas/EpisodeProgress"}},"required":["audio_url","created_at","description","generation","host_ids","id","image_url","podcast_id","published_at","scheduled_at","source_ids","status","title","updated_at","url","video_url","outputs","progress"],"description":"A podcast episode with publishing metadata, audio/video URLs when available, and its production progress."},"EpisodeProgress":{"type":"object","properties":{"error":{"type":["string","null"],"description":"Why generation or rendering failed, when it did."},"needs_attention":{"type":["object","null"],"properties":{"missing_visuals":{"type":"integer","minimum":0},"skipped_sources":{"type":"integer","minimum":0},"unvoiced_lines":{"type":"integer","minimum":0}},"required":["missing_visuals","skipped_sources","unvoiced_lines"],"description":"Gaps a usable episode still has, such as lines without audio or skipped sources. Fix them in Studio; null when there are none."},"phase":{"type":["string","null"],"description":"The work still in flight, such as `rendering` or `finalizing_outputs`. Null once the episode is idle, completed, or failed."},"poll_after_seconds":{"type":"number","minimum":0,"description":"Seconds to wait before reading the episode again. Zero means it will not change on its own."},"render_required":{"type":"boolean","description":"True when the content is ready but has no playable or downloadable output and nothing is preparing one, as after a caption or watermark edit. Outputs stay unavailable until a new render or export is requested. Call `POST /episodes/{episode_id}/export` to produce one."},"status":{"type":"string","enum":["idle","generating","completed","failed"],"description":"Whether the requested episode work is still running. `completed` means generation and all requested files finished. Individual output status reports each file before the request finishes."}},"required":["error","needs_attention","phase","poll_after_seconds","render_required","status"],"description":"Where the episode stands across generation and rendering. MCP `get_content` reports the same progress.","readOnly":true},"UploadEpisodeImageResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"image_url":{"type":"string"}},"required":["id","image_url"]}},"required":["data"],"description":"The uploaded image URL."},"PublishEpisodeResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string"},"scheduled_time":{"type":"string"},"status":{"type":"string","enum":["published","scheduled"]}},"required":["id","status"]}},"required":["data"],"description":"Result of a publish or schedule operation."},"PublishEpisodeInput":{"type":"object","properties":{"scheduled_time":{"type":"string","format":"date-time"}},"additionalProperties":false,"description":"Optional publishing options. Omit to publish immediately; provide `scheduled_time` to schedule for later."},"TimestampsJsonResponse":{"type":"object","properties":{"data":{"type":"object","properties":{"episode_id":{"type":"string"},"speakers":{"type":"array","items":{"type":"object","properties":{"host_id":{"type":"string"},"name":{"type":"string"}},"required":["host_id","name"]}},"words":{"type":"array","items":{"type":"object","properties":{"end":{"type":"number"},"speaker":{"type":["number","null"]},"start":{"type":"number"},"text":{"type":"string"}},"required":["end","speaker","start","text"]}}},"required":["episode_id","speakers","words"]}},"required":["data"],"description":"Word-level episode timestamps with speaker attribution. Speakers are referenced by integer index into the `speakers` array."},"ListHostsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/HostRow"}}},"required":["data"],"description":"Page of hosts. Use the `Link` response header (`rel=\"next\"`) to paginate."},"HostRow":{"type":"object","properties":{"backstory":{"type":["string","null"]},"created_at":{"type":"string","readOnly":true},"id":{"type":"string","description":"8-character hex host id (e.g. `2e6939fe`).","example":"2e6939fe","readOnly":true},"name":{"type":"string"},"personality":{"type":["string","null"]},"title":{"type":["string","null"]},"updated_at":{"type":"string","readOnly":true},"voice":{"type":["object","null"],"properties":{"accent":{"type":["string","null"]},"description":{"type":["string","null"]},"gender":{"type":"string","enum":["male","female","other"]},"id":{"type":"integer"},"language":{"type":["string","null"]},"model":{"type":["string","null"],"description":"Provider model identifier used to synthesize this voice."},"voice_type":{"type":"string","enum":["professional","clone","design"]}},"required":["accent","description","gender","id","language","model","voice_type"]},"voice_id":{"type":["integer","null"]}},"required":["backstory","created_at","id","name","personality","title","updated_at","voice","voice_id"],"description":"A host (speaker/presenter) belonging to your organization."},"CreateHostInput":{"type":"object","properties":{"backstory":{"type":"string","minLength":10,"maxLength":3000,"description":"Plain text or HTML. Plain text is returned inside <p> tags."},"image_path":{"type":"string"},"is_guest":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":100},"personality":{"type":"string","minLength":1,"maxLength":3000,"description":"Plain text or HTML. Plain text is returned inside <p> tags."},"title":{"type":"string","minLength":1,"maxLength":100},"voice_id":{"type":"integer"}},"required":["backstory","name","voice_id"],"additionalProperties":false,"description":"Fields required to create a host."},"UpdateHostInput":{"type":"object","properties":{"backstory":{"type":"string","minLength":10,"maxLength":3000,"description":"Plain text or HTML. Plain text is returned inside <p> tags."},"image_path":{"type":"string"},"is_guest":{"type":"boolean"},"name":{"type":"string","minLength":1,"maxLength":100},"personality":{"type":"string","minLength":1,"maxLength":3000,"description":"Plain text or HTML. Plain text is returned inside <p> tags."},"title":{"type":"string","minLength":1,"maxLength":100},"voice_id":{"type":"integer"}},"additionalProperties":false,"description":"Patchable host fields. All optional; only provided fields are updated."},"Insights":{"type":"object","properties":{"as_of":{"type":["string","null"],"description":"ISO-8601 time the saved analytics behind these numbers were captured. Null when nothing has been captured yet.","readOnly":true},"channels":{"type":"array","items":{"type":"object","properties":{"engagement":{"type":["object","null"],"properties":{"comments":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"reactions":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]}},"required":["comments","reactions"]},"followers":{"type":["object","null"],"properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"name":{"type":"string"},"network":{"type":["string","null"]},"plays":{"type":["object","null"],"properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"posts":{"type":["object","null"],"properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"source":{"type":"string","enum":["feed","player","channel"]}},"required":["engagement","followers","name","network","plays","posts","source"]},"description":"Items posted, plays, engagement, and net followers gained per source: `feed` (podcast feeds), `player` (the Jellypod player), and each connected `channel`. A null value means the source does not report it."},"complete":{"type":"boolean","description":"Whether every measured podcast has a saved analytics capture. When false the numbers are a floor rather than a total; retry later for a complete read.","readOnly":true},"period":{"type":"string","enum":["7d","30d","month","last-month","custom","last-week"]},"previous":{"type":"object","properties":{"end":{"type":"string","format":"date"},"start":{"type":"string","format":"date"}},"required":["end","start"],"description":"The equal-length period just before `range`, which every `previous` value covers."},"range":{"type":"object","properties":{"end":{"type":"string","format":"date"},"start":{"type":"string","format":"date"}},"required":["end","start"],"description":"Inclusive UTC days the `current` values cover."},"studio_url":{"type":"string","format":"uri","description":"The Studio Insights page for the same period and filter."},"summary":{"type":"object","properties":{"channels_posted":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"engagement":{"type":["object","null"],"properties":{"comments":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"reactions":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"rate":{"type":"object","properties":{"current":{"type":["number","null"]},"previous":{"type":["number","null"]}},"required":["current","previous"]}},"required":["comments","reactions","rate"]},"plays":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"published":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]},"watch_time_sec":{"type":"object","properties":{"current":{"type":"number"},"previous":{"type":"number"}},"required":["current","previous"]}},"required":["channels_posted","engagement","plays","published","watch_time_sec"],"description":"Total plays, watch time in seconds (Jellypod player and YouTube), items published, Channels posted to, and reactions and comments with their rate per play, each as `current` and `previous`. `engagement` is null when no source captured it."},"takeaways":{"type":"array","items":{"type":"object","properties":{"action":{"type":"object","properties":{"label":{"type":"string"},"url":{"type":"string","format":"uri"}},"required":["label","url"]},"body":{"type":"string"},"id":{"type":"string"},"title":{"type":"string"}},"required":["action","body","id","title"]},"description":"Up to three suggested next steps for the whole library, each with a Studio action."},"top_content":{"type":"array","items":{"type":"object","properties":{"comments":{"type":["number","null"]},"id":{"type":"string"},"kind":{"type":"string","enum":["episode","video","short","voiceover"]},"plays":{"type":"number"},"published_at":{"type":["string","null"]},"reactions":{"type":["number","null"]},"title":{"type":"string"},"watch_time_sec":{"type":"number"}},"required":["comments","id","kind","plays","published_at","reactions","title","watch_time_sec"]},"description":"The five items with the most plays in `range`."}},"required":["as_of","channels","complete","period","previous","range","studio_url","summary","takeaways","top_content"],"description":"Organization-wide performance for one period, with the same totals as the Studio Insights page."},"ListPodcastsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Podcast"}}},"required":["data"],"description":"Page of podcasts. Use the `Link` response header (`rel=\"next\"`) to paginate."},"Podcast":{"type":"object","properties":{"author":{"type":["string","null"]},"created_at":{"type":"string","readOnly":true},"description":{"type":"string"},"episode_count":{"type":"integer","minimum":0,"description":"Number of episodes that belong to this podcast.","readOnly":true},"episode_order":{"type":"string","enum":["episodic","serial"],"description":"Episode ordering: `episodic` (standalone) or `serial` (sequential). Always returned lowercase."},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid","readOnly":true},"image_url":{"type":["string","null"]},"languages":{"type":"array","items":{"type":"string"}},"primary_category":{"type":["string","null"]},"rss_feed_url":{"type":["string","null"],"description":"Public RSS feed URL. Null while podcast visibility is private.","readOnly":true},"secondary_category":{"type":["string","null"]},"title":{"type":"string"},"updated_at":{"type":"string","readOnly":true},"url":{"type":["string","null"],"description":"Public podcast website URL. Null while podcast visibility is private.","readOnly":true},"visibility":{"type":["string","null"],"enum":["public","private","unlisted",null],"description":"Visibility. Always returned lowercase."}},"required":["author","created_at","description","episode_count","episode_order","host_ids","id","image_url","languages","primary_category","rss_feed_url","secondary_category","title","updated_at","url","visibility"],"description":"A podcast in your library with metadata, hosts, languages, and feed URLs."},"CreatePodcastInput":{"type":"object","properties":{"author":{"type":["string","null"],"maxLength":255,"description":"Credited author for itunes:author and itunes:owner. Null or blank credits the podcast title."},"description":{"type":"string","description":"Plain text or HTML. Plain text is returned inside <p> tags."},"episode_order":{"type":"string","enum":["episodic","serial"],"default":"serial"},"host_ids":{"type":"array","items":{"type":"string"},"minItems":1},"language":{"type":"string","pattern":"^[a-zA-Z]{2,3}$/u","default":"en"},"primary_category":{"type":"string","enum":["Arts","Books","Design","Fashion & Beauty","Food","Performing Arts","Visual Arts","Business","Careers","Entrepreneurship","Investing","Management","Marketing","Non-Profit","Comedy","Comedy Interviews","Improv","Stand-Up","Education","Courses","How To","Language Learning","Self-Improvement","Fiction","Comedy Fiction","Drama","Science Fiction","Government","History","Health & Fitness","Alternative Health","Fitness","Medicine","Mental Health","Nutrition","Sexuality","Kids & Family","Education for Kids","Parenting","Pets & Animals","Stories for Kids","Leisure","Animation & Manga","Automotive","Aviation","Crafts","Games","Hobbies","Home & Garden","Video Games","Music","Music Commentary","Music History","Music Interviews","News","Business News","Daily News","Entertainment News","News Commentary","Politics","Sports News","Tech News","Religion & Spirituality","Buddhism","Christianity","Hinduism","Islam","Judaism","Religion","Spirituality","Science","Astronomy","Chemistry","Earth Sciences","Life Sciences","Mathematics","Natural Sciences","Nature","Physics","Social Sciences","Society & Culture","Documentary","Personal Journals","Philosophy","Places & Travel","Relationships","Sports","Baseball","Basketball","Cricket","Fantasy Sports","Football","Golf","Hockey","Rugby","Running","Soccer","Swimming","Tennis","Volleyball","Wilderness","Wrestling","Technology","True Crime","TV & Film","After Shows","Film History","Film Interviews","Film Reviews","TV Reviews"],"description":"Apple Podcasts category or subcategory. The RSS feed nests a subcategory under its parent category."},"secondary_category":{"type":["string","null"],"enum":["Arts","Books","Design","Fashion & Beauty","Food","Performing Arts","Visual Arts","Business","Careers","Entrepreneurship","Investing","Management","Marketing","Non-Profit","Comedy","Comedy Interviews","Improv","Stand-Up","Education","Courses","How To","Language Learning","Self-Improvement","Fiction","Comedy Fiction","Drama","Science Fiction","Government","History","Health & Fitness","Alternative Health","Fitness","Medicine","Mental Health","Nutrition","Sexuality","Kids & Family","Education for Kids","Parenting","Pets & Animals","Stories for Kids","Leisure","Animation & Manga","Automotive","Aviation","Crafts","Games","Hobbies","Home & Garden","Video Games","Music","Music Commentary","Music History","Music Interviews","News","Business News","Daily News","Entertainment News","News Commentary","Politics","Sports News","Tech News","Religion & Spirituality","Buddhism","Christianity","Hinduism","Islam","Judaism","Religion","Spirituality","Science","Astronomy","Chemistry","Earth Sciences","Life Sciences","Mathematics","Natural Sciences","Nature","Physics","Social Sciences","Society & Culture","Documentary","Personal Journals","Philosophy","Places & Travel","Relationships","Sports","Baseball","Basketball","Cricket","Fantasy Sports","Football","Golf","Hockey","Rugby","Running","Soccer","Swimming","Tennis","Volleyball","Wilderness","Wrestling","Technology","True Crime","TV & Film","After Shows","Film History","Film Interviews","Film Reviews","TV Reviews",null],"description":"Optional second Apple Podcasts category or subcategory."},"title":{"type":"string","maxLength":100},"visibility":{"type":"string","enum":["public","private"],"default":"public"}},"required":["host_ids","title"],"additionalProperties":false,"description":"Fields required to create a podcast."},"UpdatePodcastInput":{"type":"object","properties":{"author":{"type":["string","null"],"maxLength":255,"description":"Credited author for itunes:author and itunes:owner. Null or blank credits the podcast title."},"description":{"type":"string","description":"Plain text or HTML. Plain text is returned inside <p> tags."},"episode_order":{"type":"string","enum":["episodic","serial"]},"host_ids":{"type":"array","items":{"type":"string"},"minItems":1},"language":{"type":"string","pattern":"^[a-zA-Z]{2,3}$/u"},"primary_category":{"type":"string","enum":["Arts","Books","Design","Fashion & Beauty","Food","Performing Arts","Visual Arts","Business","Careers","Entrepreneurship","Investing","Management","Marketing","Non-Profit","Comedy","Comedy Interviews","Improv","Stand-Up","Education","Courses","How To","Language Learning","Self-Improvement","Fiction","Comedy Fiction","Drama","Science Fiction","Government","History","Health & Fitness","Alternative Health","Fitness","Medicine","Mental Health","Nutrition","Sexuality","Kids & Family","Education for Kids","Parenting","Pets & Animals","Stories for Kids","Leisure","Animation & Manga","Automotive","Aviation","Crafts","Games","Hobbies","Home & Garden","Video Games","Music","Music Commentary","Music History","Music Interviews","News","Business News","Daily News","Entertainment News","News Commentary","Politics","Sports News","Tech News","Religion & Spirituality","Buddhism","Christianity","Hinduism","Islam","Judaism","Religion","Spirituality","Science","Astronomy","Chemistry","Earth Sciences","Life Sciences","Mathematics","Natural Sciences","Nature","Physics","Social Sciences","Society & Culture","Documentary","Personal Journals","Philosophy","Places & Travel","Relationships","Sports","Baseball","Basketball","Cricket","Fantasy Sports","Football","Golf","Hockey","Rugby","Running","Soccer","Swimming","Tennis","Volleyball","Wilderness","Wrestling","Technology","True Crime","TV & Film","After Shows","Film History","Film Interviews","Film Reviews","TV Reviews"],"description":"Apple Podcasts category or subcategory. The RSS feed nests a subcategory under its parent category."},"secondary_category":{"type":["string","null"],"enum":["Arts","Books","Design","Fashion & Beauty","Food","Performing Arts","Visual Arts","Business","Careers","Entrepreneurship","Investing","Management","Marketing","Non-Profit","Comedy","Comedy Interviews","Improv","Stand-Up","Education","Courses","How To","Language Learning","Self-Improvement","Fiction","Comedy Fiction","Drama","Science Fiction","Government","History","Health & Fitness","Alternative Health","Fitness","Medicine","Mental Health","Nutrition","Sexuality","Kids & Family","Education for Kids","Parenting","Pets & Animals","Stories for Kids","Leisure","Animation & Manga","Automotive","Aviation","Crafts","Games","Hobbies","Home & Garden","Video Games","Music","Music Commentary","Music History","Music Interviews","News","Business News","Daily News","Entertainment News","News Commentary","Politics","Sports News","Tech News","Religion & Spirituality","Buddhism","Christianity","Hinduism","Islam","Judaism","Religion","Spirituality","Science","Astronomy","Chemistry","Earth Sciences","Life Sciences","Mathematics","Natural Sciences","Nature","Physics","Social Sciences","Society & Culture","Documentary","Personal Journals","Philosophy","Places & Travel","Relationships","Sports","Baseball","Basketball","Cricket","Fantasy Sports","Football","Golf","Hockey","Rugby","Running","Soccer","Swimming","Tennis","Volleyball","Wilderness","Wrestling","Technology","True Crime","TV & Film","After Shows","Film History","Film Interviews","Film Reviews","TV Reviews",null],"description":"Optional second Apple Podcasts category or subcategory."},"title":{"type":"string","maxLength":100},"visibility":{"type":"string","enum":["public","private","unlisted"]}},"additionalProperties":false,"description":"Patchable podcast fields. All optional; only provided fields are updated."},"ListSourcesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SourceRow"}}},"required":["data"],"description":"Page of sources. Use the `Link` response header (`rel=\"next\"`) to paginate."},"SourceRow":{"type":"object","properties":{"created_at":{"type":"string","readOnly":true},"error_message":{"type":["string","null"]},"id":{"type":"string","format":"uuid","readOnly":true},"metadata":{},"status":{"type":"string","readOnly":true},"title":{"type":["string","null"]},"type":{"type":["string","null"]},"updated_at":{"type":"string","readOnly":true}},"required":["created_at","error_message","id","status","title","type","updated_at"],"description":"A content source used as input for episodes."},"AcceptedSourceResponse":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SourceRow"}},"required":["data"],"description":"Acknowledgement for asynchronous source processing."},"CreateSourceInput":{"oneOf":[{"type":"object","properties":{"title":{"type":"string"},"type":{"type":"string","enum":["url"]},"url":{"type":"string","format":"uri"}},"required":["type","url"],"additionalProperties":false},{"type":"object","properties":{"title":{"type":"string"},"type":{"type":"string","enum":["youtube"]},"url":{"type":"string","format":"uri"}},"required":["type","url"],"additionalProperties":false},{"type":"object","properties":{"content":{"type":"string","maxLength":100000},"title":{"type":"string"},"type":{"type":"string","enum":["text"]}},"required":["content","type"],"additionalProperties":false}],"description":"Body for creating a URL, YouTube, or text source. `type` is case-insensitive — the server lowercases it before validation. `url` is required when `type` is `url` or `youtube`; `content` is required when `type` is `text`."},"ListVoicesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/VoiceRow"}}},"required":["data"],"description":"Page of voices. Use the `Link` response header (`rel=\"next\"`) to paginate."},"VoiceRow":{"type":"object","properties":{"accent":{"type":["string","null"]},"description":{"type":["string","null"]},"gender":{"type":"string","enum":["male","female","other"]},"id":{"type":"integer","description":"Positive integer voice id. Pass this value (as a number, not a string) to `voice_id` on `POST /v1/hosts`.","example":30142,"readOnly":true},"language":{"type":["string","null"],"description":"Language code the voice is filed under: the two-letter ISO 639-1 code where one exists, or the three-letter code where it does not (e.g. \"en\", \"ja\", \"fil\"). New codes appear as the catalog grows, so treat this as an open set rather than a fixed list.","example":"en","readOnly":true},"model":{"type":["string","null"],"description":"Provider-prefixed model string used to synthesize this voice (e.g. \"elevenlabs/eleven_v3\"). Null when the voice has no model configured.","example":"elevenlabs/eleven_v3","readOnly":true},"voice_type":{"type":"string","enum":["professional","clone","design"]}},"required":["accent","description","gender","id","language","model","voice_type"],"description":"A TTS voice available to your organization."}},"parameters":{}},"paths":{"/":{"get":{"operationId":"getApiIndex","security":[],"summary":"API discovery index","tags":["Health"],"responses":{"200":{"description":"Links to the API documentation, spec, and related services.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiIndex"}}}}}}},"/health":{"get":{"operationId":"health","tags":["Health"],"security":[],"responses":{"200":{"description":"Service is healthy","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","enum":["ok"]}},"required":["status"]}}}}}}},"/v1/account":{"get":{"operationId":"getAccount","summary":"Get the authenticated organization","tags":["Account"],"security":[{"bearerAuth":[]}],"responses":{"200":{"description":"Authenticated organization details","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/analytics":{"get":{"operationId":"getEpisodeAnalytics","security":[{"bearerAuth":[]}],"summary":"Get streaming analytics for an episode","tags":["Analytics"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"responses":{"200":{"description":"Episode analytics","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EpisodeAnalytics"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/podcasts/{podcast_id}/analytics":{"get":{"operationId":"getPodcastAnalytics","security":[{"bearerAuth":[]}],"summary":"Get streaming analytics for a podcast","tags":["Analytics"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Podcast UUID"},"required":true,"description":"Podcast UUID","in":"path","name":"podcast_id"}],"responses":{"200":{"description":"Podcast analytics","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PodcastAnalytics"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes":{"get":{"operationId":"listEpisodes","security":[{"bearerAuth":[]}],"summary":"List episodes","tags":["Episodes"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","format":"uuid"},"required":false,"name":"podcast_id","in":"query"},{"schema":{"type":"string"},"required":false,"name":"status","in":"query"}],"responses":{"200":{"description":"Page of episodes","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListEpisodesResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"description":"Inserts an episode row with only the metadata you provide. No script, audio, or video is generated. Use `POST /v1/episodes/generate` to create an episode and trigger generation in one call.","operationId":"createEpisode","security":[{"bearerAuth":[]}],"summary":"Create an empty episode","tags":["Episodes"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEpisodeInput"}}}},"responses":{"201":{"description":"Episode created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Episode"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/generate":{"post":{"operationId":"generateEpisode","security":[{"bearerAuth":[]}],"summary":"Generate a new episode (asynchronous)","tags":["Episodes"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GenerateEpisodeInput"}}}},"responses":{"202":{"description":"Episode queued for generation","headers":{"Location":{"description":"Relative URL clients can poll for the accepted resource.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedEpisodeResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"The API could not enqueue the downstream asynchronous workflow.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/import":{"post":{"operationId":"importEpisode","security":[{"bearerAuth":[]}],"description":"Generates a new episode from finished script text, asynchronously. Poll its status for progress.","summary":"Import a script as a new episode","tags":["Episodes"],"parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImportEpisodeInput"}}}},"responses":{"202":{"description":"Imported episode queued for generation","headers":{"Location":{"description":"Relative URL clients can poll for the accepted resource.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedEpisodeResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Request was well-formed but the resource is in a state that does not allow this operation (e.g. publishing an episode that has not finished rendering).","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"The API could not enqueue the downstream asynchronous workflow.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/export":{"post":{"operationId":"exportEpisode","security":[{"bearerAuth":[]}],"summary":"Export saved episode content","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"outputs":{"type":"array","items":{"type":"string","enum":["audio","video"]},"minItems":1,"maxItems":2}},"required":["outputs"],"additionalProperties":false}}}},"responses":{"202":{"description":"Requested files are available or being prepared from saved content. Poll the episode for readiness.","headers":{"Location":{"description":"Relative URL clients can poll for the accepted resource.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"outputs":{"type":"object","properties":{"audio":{"type":"object","properties":{"current":{"type":"boolean"},"download_url":{"type":["string","null"],"format":"uri"},"error":{"type":["string","null"]},"status":{"type":"string","enum":["not_requested","preparing","available","failed"]}},"required":["current","download_url","error","status"]},"video":{"type":"object","properties":{"current":{"type":"boolean"},"download_url":{"type":["string","null"],"format":"uri"},"error":{"type":["string","null"]},"status":{"type":"string","enum":["not_requested","preparing","available","failed"]}},"required":["current","download_url","error","status"]}},"required":["audio","video"]},"progress":{"type":"object","properties":{"error":{"type":["string","null"]},"needs_attention":{"type":["object","null"],"properties":{"missing_visuals":{"type":"integer","minimum":0},"skipped_sources":{"type":"integer","minimum":0},"unvoiced_lines":{"type":"integer","minimum":0}},"required":["missing_visuals","skipped_sources","unvoiced_lines"]},"phase":{"type":["string","null"]},"poll_after_seconds":{"type":"number","minimum":0},"render_required":{"type":"boolean","description":"True when the content is ready but has no playable or downloadable output and nothing is preparing one, as after a caption or watermark edit. Outputs stay unavailable until a new render or export is requested."},"status":{"type":"string","enum":["idle","generating","completed","failed"]}},"required":["error","needs_attention","phase","poll_after_seconds","render_required","status"]}},"required":["id","outputs","progress"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The content is generating, already usable, or failed in a way another attempt cannot fix. Nothing was started; the message says what to do instead.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Request was well-formed but the resource is in a state that does not allow this operation (e.g. publishing an episode that has not finished rendering).","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"The API could not enqueue the downstream asynchronous workflow.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}":{"patch":{"operationId":"updateEpisode","security":[{"bearerAuth":[]}],"summary":"Update episode fields","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEpisodeInput"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateEpisodeInput"}}}},"responses":{"200":{"description":"Updated episode","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Episode"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"get":{"operationId":"getEpisode","security":[{"bearerAuth":[]}],"summary":"Get an episode","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"responses":{"200":{"description":"Episode with its progress. While `progress.poll_after_seconds` is above zero, the `Retry-After` header carries the same wait.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EpisodeDetail"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"deleteEpisode","security":[{"bearerAuth":[]}],"summary":"Delete an episode","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"responses":{"204":{"description":"Episode deleted"},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/image":{"put":{"operationId":"uploadEpisodeImage","security":[{"bearerAuth":[]}],"description":"Send the raw image bytes as the request body.","summary":"Upload an episode cover image","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"requestBody":{"description":"Raw image bytes. Set `Content-Type` to `image/jpeg`, `image/png`, or `image/webp`.","required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Image uploaded","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UploadEpisodeImageResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/publish":{"post":{"operationId":"publishEpisode","security":[{"bearerAuth":[]}],"summary":"Publish or schedule an episode","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"requestBody":{"required":false,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishEpisodeInput"}}}},"responses":{"200":{"description":"Episode published or scheduled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublishEpisodeResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Request was well-formed but the resource is in a state that does not allow this operation (e.g. publishing an episode that has not finished rendering).","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/unpublish":{"post":{"operationId":"unpublishEpisode","security":[{"bearerAuth":[]}],"summary":"Unpublish a published or scheduled episode","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"responses":{"200":{"description":"Episode unpublished","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Episode"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"Request was well-formed but the resource is in a state that does not allow this operation (e.g. publishing an episode that has not finished rendering).","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/timestamps":{"get":{"description":"Returns timestamps in the requested `format`. Use `format=json` (default) for structured timestamps, `format=srt` for SubRip, or `format=vtt` for WebVTT.","operationId":"getEpisodeTimestamps","security":[{"bearerAuth":[]}],"summary":"Get episode timestamps","tags":["Episodes"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"},{"schema":{"type":"string","enum":["json","srt","vtt"],"description":"Response format. `json` returns word-level timestamps with speaker attribution; `srt` returns SubRip; `vtt` returns WebVTT. Defaults to `json`."},"required":false,"description":"Response format. `json` returns word-level timestamps with speaker attribution; `srt` returns SubRip; `vtt` returns WebVTT. Defaults to `json`.","in":"query","name":"format"}],"responses":{"200":{"description":"Timestamps in the requested format. Response `Content-Type` reflects `format`.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TimestampsJsonResponse"}},"application/x-subrip":{"schema":{"type":"string"}},"text/vtt":{"schema":{"type":"string"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/status":{"get":{"security":[{"bearerAuth":[]}],"tags":["Episodes"],"operationId":"getEpisodeStatus","summary":"Check episode generation","parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"responses":{"200":{"description":"Current generation and rendering status. While `poll_after_seconds` is above zero, the `Retry-After` header carries the same wait.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"error":{"type":["string","null"]},"id":{"type":"string","format":"uuid"},"needs_attention":{"type":["object","null"],"properties":{"missing_visuals":{"type":"integer","minimum":0},"skipped_sources":{"type":"integer","minimum":0},"unvoiced_lines":{"type":"integer","minimum":0}},"required":["missing_visuals","skipped_sources","unvoiced_lines"]},"object":{"type":"string","enum":["episode"]},"phase":{"type":["string","null"]},"poll_after_seconds":{"type":"number"},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"}},"required":["error","id","needs_attention","object","phase","poll_after_seconds","status","studio_url"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/retry":{"post":{"security":[{"bearerAuth":[]}],"tags":["Episodes"],"operationId":"retryEpisode","summary":"Retry a failed episode","parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"responses":{"202":{"description":"Generation retry accepted. Check the status URL until generation finishes.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Episode"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"409":{"description":"The content is generating, already usable, or failed in a way another attempt cannot fix. Nothing was started; the message says what to do instead.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/download":{"get":{"security":[{"bearerAuth":[]}],"tags":["Episodes"],"operationId":"downloadEpisode","summary":"Get the episode download","parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"},{"schema":{"type":"string","enum":["audio","video"],"description":"Which output to download: `audio` (default) or `video`. Request the format in outputs when generating or exporting."},"required":false,"description":"Which output to download: `audio` (default) or `video`. Request the format in outputs when generating or exporting.","in":"query","name":"media"}],"responses":{"200":{"description":"Download the served audio or video for a published or scheduled episode, or the latest successful file for a draft. Episode outputs expose newer draft exports separately.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"delivery":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["available"]},"origin":{"type":"string","enum":["mux","storage"]},"url":{"type":"string","format":"uri"}},"required":["kind","origin","url"]},{"type":"object","properties":{"kind":{"type":"string","enum":["preparing"]},"reason":{"type":"string","enum":["ingest"]}},"required":["kind","reason"]},{"type":"object","properties":{"kind":{"type":"string","enum":["unavailable"]}},"required":["kind"]}]},"id":{"type":"string","format":"uuid"},"media":{"type":"string","enum":["audio","video"]},"object":{"type":"string","enum":["episode"]}},"required":["delivery","id","media","object"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/episodes/{episode_id}/video-settings":{"get":{"security":[{"bearerAuth":[]}],"tags":["Episodes"],"operationId":"getEpisodeVideoSettings","summary":"Get episode captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Podcast default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"security":[{"bearerAuth":[]}],"tags":["Episodes"],"operationId":"updateEpisodeVideoSettings","summary":"Update episode captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid","description":"Episode UUID"},"required":true,"description":"Episode UUID","in":"path","name":"episode_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}},"application/merge-patch+json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Podcast default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/hosts":{"get":{"operationId":"listHosts","security":[{"bearerAuth":[]}],"summary":"List hosts","tags":["Hosts"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Page of hosts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListHostsResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"createHost","security":[{"bearerAuth":[]}],"summary":"Create a host","tags":["Hosts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateHostInput"}}}},"responses":{"201":{"description":"Host created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HostRow"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/hosts/{host_id}":{"get":{"operationId":"getHost","security":[{"bearerAuth":[]}],"summary":"Get a host","tags":["Hosts"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9a-f]{8}$/iu","description":"8-character hex host id (e.g. `2e6939fe`).","example":"2e6939fe"},"required":true,"description":"8-character hex host id (e.g. `2e6939fe`).","in":"path","name":"host_id"}],"responses":{"200":{"description":"Host","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HostRow"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"operationId":"updateHost","security":[{"bearerAuth":[]}],"summary":"Update a host","tags":["Hosts"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9a-f]{8}$/iu","description":"8-character hex host id (e.g. `2e6939fe`).","example":"2e6939fe"},"required":true,"description":"8-character hex host id (e.g. `2e6939fe`).","in":"path","name":"host_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateHostInput"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdateHostInput"}}}},"responses":{"200":{"description":"Host updated","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/HostRow"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"deleteHost","security":[{"bearerAuth":[]}],"summary":"Delete a host","tags":["Hosts"],"parameters":[{"schema":{"type":"string","pattern":"^[0-9a-f]{8}$/iu","description":"8-character hex host id (e.g. `2e6939fe`).","example":"2e6939fe"},"required":true,"description":"8-character hex host id (e.g. `2e6939fe`).","in":"path","name":"host_id"}],"responses":{"204":{"description":"Host deleted"},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/insights":{"get":{"operationId":"getInsights","security":[{"bearerAuth":[]}],"summary":"Get Insights across all content","tags":["Analytics"],"parameters":[{"schema":{"type":"string","enum":["7d","30d","month","last-month","custom","last-week"],"default":"30d","description":"Reporting period in UTC days: 7d, 30d (default), month (month to date), last-month, last-week (the last complete Monday to Sunday week), or custom with from and to. Every number is compared with the period of equal length just before it."},"required":false,"description":"Reporting period in UTC days: 7d, 30d (default), month (month to date), last-month, last-week (the last complete Monday to Sunday week), or custom with from and to. Every number is compared with the period of equal length just before it.","name":"period","in":"query"},{"schema":{"type":"string","format":"date","description":"First day (YYYY-MM-DD, UTC) of a custom period."},"required":false,"description":"First day (YYYY-MM-DD, UTC) of a custom period.","name":"from","in":"query"},{"schema":{"type":"string","format":"date","description":"Last day (YYYY-MM-DD, UTC) of a custom period, at most 180 days after from. A day after today reads as today."},"required":false,"description":"Last day (YYYY-MM-DD, UTC) of a custom period, at most 180 days after from. A day after today reads as today.","name":"to","in":"query"},{"schema":{"type":"string","enum":["episode","video","short"],"description":"Count only Episodes, Videos, or Shorts."},"required":false,"description":"Count only Episodes, Videos, or Shorts.","name":"kind","in":"query"}],"responses":{"200":{"description":"Organization-wide Insights for the period","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Insights"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/podcasts":{"get":{"operationId":"listPodcasts","security":[{"bearerAuth":[]}],"summary":"List podcasts","tags":["Podcasts"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Page of podcasts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPodcastsResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"createPodcast","security":[{"bearerAuth":[]}],"summary":"Create a podcast","tags":["Podcasts"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePodcastInput"}}}},"responses":{"201":{"description":"Podcast created","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Podcast"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/podcasts/{podcast_id}":{"get":{"operationId":"getPodcast","security":[{"bearerAuth":[]}],"summary":"Get a podcast","tags":["Podcasts"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Podcast UUID"},"required":true,"description":"Podcast UUID","in":"path","name":"podcast_id"}],"responses":{"200":{"description":"Podcast","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Podcast"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"operationId":"updatePodcast","security":[{"bearerAuth":[]}],"summary":"Update a podcast","tags":["Podcasts"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Podcast UUID"},"required":true,"description":"Podcast UUID","in":"path","name":"podcast_id"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePodcastInput"}},"application/merge-patch+json":{"schema":{"$ref":"#/components/schemas/UpdatePodcastInput"}}}},"responses":{"200":{"description":"Podcast updated","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Podcast"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"deletePodcast","security":[{"bearerAuth":[]}],"summary":"Delete a podcast","tags":["Podcasts"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Podcast UUID"},"required":true,"description":"Podcast UUID","in":"path","name":"podcast_id"}],"responses":{"204":{"description":"Podcast deleted"},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/podcasts/{podcast_id}/image":{"put":{"operationId":"updatePodcastImage","security":[{"bearerAuth":[]}],"summary":"Replace the podcast cover image","tags":["Podcasts"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Podcast UUID"},"required":true,"description":"Podcast UUID","in":"path","name":"podcast_id"}],"requestBody":{"description":"Raw image bytes. Set `Content-Type` to `image/jpeg`, `image/png`, or `image/webp`.","required":true,"content":{"application/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"200":{"description":"Image updated","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Podcast"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/sources":{"get":{"operationId":"listSources","security":[{"bearerAuth":[]}],"summary":"List sources","tags":["Sources"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"status","in":"query"},{"schema":{"type":"string"},"required":false,"name":"type","in":"query"}],"responses":{"200":{"description":"Page of sources","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListSourcesResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"operationId":"createSource","security":[{"bearerAuth":[]}],"description":"Creates a Source from a web URL, a YouTube link, or a text payload.","summary":"Create a source","tags":["Sources"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateSourceInput"}}}},"responses":{"202":{"description":"Source accepted for processing","headers":{"Location":{"description":"Relative URL clients can poll for the accepted resource.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedSourceResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"The API could not enqueue the downstream asynchronous workflow.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/sources/{source_id}":{"get":{"operationId":"getSource","security":[{"bearerAuth":[]}],"summary":"Get a source","tags":["Sources"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Source UUID"},"required":true,"description":"Source UUID","in":"path","name":"source_id"}],"responses":{"200":{"description":"Source","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SourceRow"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"deleteSource","security":[{"bearerAuth":[]}],"summary":"Delete a source","tags":["Sources"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Source UUID"},"required":true,"description":"Source UUID","in":"path","name":"source_id"}],"responses":{"204":{"description":"Source deleted"},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/sources/uploads":{"post":{"operationId":"requestSourceUpload","security":[{"bearerAuth":[]}],"description":"Reserves a file Source and returns a scoped URL to upload the file to.","summary":"Request a file upload","tags":["Sources"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"file_name":{"type":"string","minLength":1,"maxLength":255},"mime_type":{"type":"string"},"prepare_visuals":{"type":"boolean","default":false,"description":"Deprecated compatibility field. Source preparation is automatic.","deprecated":true},"size_bytes":{"type":"integer","exclusiveMinimum":0,"description":"File size in bytes, up to 100 MB for all supported Source files."},"title":{"type":"string","minLength":1,"maxLength":500}},"required":["file_name","mime_type","size_bytes"],"additionalProperties":false}}}},"responses":{"201":{"description":"Upload slot reserved. PUT raw file bytes to upload.url with the returned headers, then POST complete_path. File content is processed asynchronously.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"complete_path":{"type":"string"},"source":{"type":"object","properties":{"created_at":{"type":"string"},"error_message":{"type":["string","null"]},"id":{"type":"string","format":"uuid"},"metadata":{},"status":{"type":"string"},"title":{"type":["string","null"]},"type":{"type":["string","null"]},"updated_at":{"type":"string"}},"required":["created_at","error_message","id","status","title","type","updated_at"]},"upload":{"type":"object","properties":{"expires_at":{"type":"string","format":"date-time"},"headers":{"type":"object","properties":{"content-type":{"type":"string"}},"required":["content-type"]},"method":{"type":"string","enum":["PUT"]},"url":{"type":"string","format":"uri"}},"required":["expires_at","headers","method","url"]}},"required":["complete_path","source","upload"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"The API could not enqueue the downstream asynchronous workflow.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/sources/{source_id}/complete-upload":{"post":{"operationId":"completeSourceUpload","security":[{"bearerAuth":[]}],"description":"Validates the uploaded file and starts processing the Source.","summary":"Complete a file upload","tags":["Sources"],"parameters":[{"schema":{"type":"string","format":"uuid","description":"Source UUID"},"required":true,"description":"Source UUID","in":"path","name":"source_id"}],"responses":{"202":{"description":"File accepted for processing. Voiceover requires completed Sources prepared with visuals; Video and Short workflows can wait for processing Sources.","headers":{"Location":{"description":"Relative URL clients can poll for the accepted resource.","schema":{"type":"string"}},"Retry-After":{"description":"Suggested polling delay in seconds.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AcceptedSourceResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"502":{"description":"The API could not enqueue the downstream asynchronous workflow.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/videos/options":{"get":{"operationId":"getVideoOptions","security":[{"bearerAuth":[]}],"summary":"Discover video creation options","tags":["Videos"],"responses":{"200":{"description":"Creation options and saved defaults","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"default_duration_seconds":{"type":["number","null"]},"default_language":{"type":"string"},"default_orientation":{"type":"string"},"default_style_id":{"type":["string","null"]},"guidance":{"type":"string"},"object":{"type":"string","enum":["video","short","voiceover"]},"styles":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["description","id","name"]}},"supported_duration_seconds":{"type":"array","items":{"type":"number"}}},"required":["default_duration_seconds","default_language","default_orientation","default_style_id","guidance","object","styles","supported_duration_seconds"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/shorts/options":{"get":{"operationId":"getShortOptions","security":[{"bearerAuth":[]}],"summary":"Discover short creation options","tags":["Shorts"],"responses":{"200":{"description":"Creation options and saved defaults","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"default_duration_seconds":{"type":["number","null"]},"default_language":{"type":"string"},"default_orientation":{"type":"string"},"default_style_id":{"type":["string","null"]},"guidance":{"type":"string"},"object":{"type":"string","enum":["video","short","voiceover"]},"styles":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["description","id","name"]}},"supported_duration_seconds":{"type":"array","items":{"type":"number"}}},"required":["default_duration_seconds","default_language","default_orientation","default_style_id","guidance","object","styles","supported_duration_seconds"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voiceovers/options":{"get":{"operationId":"getVoiceoverOptions","security":[{"bearerAuth":[]}],"summary":"Discover voiceover creation options","tags":["Voiceovers"],"responses":{"200":{"description":"Creation options and saved defaults","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"default_duration_seconds":{"type":["number","null"]},"default_language":{"type":"string"},"default_orientation":{"type":"string"},"default_style_id":{"type":["string","null"]},"guidance":{"type":"string"},"object":{"type":"string","enum":["video","short","voiceover"]},"styles":{"type":"array","items":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"}},"required":["description","id","name"]}},"supported_duration_seconds":{"type":"array","items":{"type":"number"}}},"required":["default_duration_seconds","default_language","default_orientation","default_style_id","guidance","object","styles","supported_duration_seconds"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/videos/{product_id}":{"get":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"operationId":"getVideo","summary":"Get a video","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Product details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"deleteVideo","security":[{"bearerAuth":[]}],"summary":"Delete a video","tags":["Videos"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"204":{"description":"Video deleted"},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/videos/{product_id}/status":{"get":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"operationId":"getVideoStatus","summary":"Check video generation","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Current generation status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["video","short","voiceover"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"needs_attention":{"type":["object","null"],"properties":{"missing_visuals":{"type":"integer","minimum":0},"skipped_sources":{"type":"integer","minimum":0},"unvoiced_lines":{"type":"integer","minimum":0}},"required":["missing_visuals","skipped_sources","unvoiced_lines"]},"poll_after_seconds":{"type":"number"}},"required":["error","generation_id","id","object","phase","status","studio_url","needs_attention","poll_after_seconds"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/videos/{product_id}/retry":{"post":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"operationId":"retryVideo","summary":"Retry a failed video","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"responses":{"202":{"description":"Generation retry accepted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/videos/{product_id}/download":{"get":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"operationId":"downloadVideo","summary":"Get the video download","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Download availability and URL","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"delivery":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["available"]},"origin":{"type":"string","enum":["mux","storage"]},"url":{"type":"string","format":"uri"}},"required":["kind","origin","url"]},{"type":"object","properties":{"kind":{"type":"string","enum":["preparing"]},"reason":{"type":"string","enum":["ingest"]}},"required":["kind","reason"]},{"type":"object","properties":{"kind":{"type":"string","enum":["unavailable"]}},"required":["kind"]}]},"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["video","short","voiceover"]}},"required":["delivery","id","object"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/videos/{product_id}/video-settings":{"get":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"operationId":"getVideoVideoSettings","summary":"Get video captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Organization default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"operationId":"updateVideoVideoSettings","summary":"Update video captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}},"application/merge-patch+json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Organization default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/shorts/{product_id}":{"get":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"operationId":"getShort","summary":"Get a short","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Product details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"deleteShort","security":[{"bearerAuth":[]}],"summary":"Delete a short","tags":["Shorts"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"204":{"description":"Short deleted"},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/shorts/{product_id}/status":{"get":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"operationId":"getShortStatus","summary":"Check short generation","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Current generation status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["video","short","voiceover"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"needs_attention":{"type":["object","null"],"properties":{"missing_visuals":{"type":"integer","minimum":0},"skipped_sources":{"type":"integer","minimum":0},"unvoiced_lines":{"type":"integer","minimum":0}},"required":["missing_visuals","skipped_sources","unvoiced_lines"]},"poll_after_seconds":{"type":"number"}},"required":["error","generation_id","id","object","phase","status","studio_url","needs_attention","poll_after_seconds"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/shorts/{product_id}/retry":{"post":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"operationId":"retryShort","summary":"Retry a failed short","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"responses":{"202":{"description":"Generation retry accepted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/shorts/{product_id}/download":{"get":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"operationId":"downloadShort","summary":"Get the short download","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Download availability and URL","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"delivery":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["available"]},"origin":{"type":"string","enum":["mux","storage"]},"url":{"type":"string","format":"uri"}},"required":["kind","origin","url"]},{"type":"object","properties":{"kind":{"type":"string","enum":["preparing"]},"reason":{"type":"string","enum":["ingest"]}},"required":["kind","reason"]},{"type":"object","properties":{"kind":{"type":"string","enum":["unavailable"]}},"required":["kind"]}]},"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["video","short","voiceover"]}},"required":["delivery","id","object"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/shorts/{product_id}/video-settings":{"get":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"operationId":"getShortVideoSettings","summary":"Get short captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Organization default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"operationId":"updateShortVideoSettings","summary":"Update short captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}},"application/merge-patch+json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Organization default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voiceovers/{product_id}":{"get":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"operationId":"getVoiceover","summary":"Get a voiceover","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Product details","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["voiceover"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"delete":{"operationId":"deleteVoiceover","security":[{"bearerAuth":[]}],"summary":"Delete a voiceover","tags":["Voiceovers"],"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"204":{"description":"Voiceover deleted"},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voiceovers/{product_id}/status":{"get":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"operationId":"getVoiceoverStatus","summary":"Check voiceover generation","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Current generation status","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["video","short","voiceover"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"needs_attention":{"type":["object","null"],"properties":{"missing_visuals":{"type":"integer","minimum":0},"skipped_sources":{"type":"integer","minimum":0},"unvoiced_lines":{"type":"integer","minimum":0}},"required":["missing_visuals","skipped_sources","unvoiced_lines"]},"poll_after_seconds":{"type":"number"}},"required":["error","generation_id","id","object","phase","status","studio_url","needs_attention","poll_after_seconds"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voiceovers/{product_id}/retry":{"post":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"operationId":"retryVoiceover","summary":"Retry a failed voiceover","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"},{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"responses":{"202":{"description":"Generation retry accepted","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["voiceover"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voiceovers/{product_id}/download":{"get":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"operationId":"downloadVoiceover","summary":"Get the voiceover download","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Download availability and URL","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"delivery":{"oneOf":[{"type":"object","properties":{"kind":{"type":"string","enum":["available"]},"origin":{"type":"string","enum":["mux","storage"]},"url":{"type":"string","format":"uri"}},"required":["kind","origin","url"]},{"type":"object","properties":{"kind":{"type":"string","enum":["preparing"]},"reason":{"type":"string","enum":["ingest"]}},"required":["kind","reason"]},{"type":"object","properties":{"kind":{"type":"string","enum":["unavailable"]}},"required":["kind"]}]},"id":{"type":"string","format":"uuid"},"object":{"type":"string","enum":["video","short","voiceover"]}},"required":["delivery","id","object"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voiceovers/{product_id}/video-settings":{"get":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"operationId":"getVoiceoverVideoSettings","summary":"Get voiceover captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Organization default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"patch":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"operationId":"updateVoiceoverVideoSettings","summary":"Update voiceover captions and watermark","parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"product_id","in":"path"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}},"application/merge-patch+json":{"schema":{"type":"object","properties":{"caption_style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"A caption style ID. Null returns to the default."},"captions_enabled":{"type":["boolean","null"],"description":"Show or hide captions. Null returns to the default."},"watermark":{"type":["object","null"],"properties":{"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]}},"required":["position"],"description":"Moves the current watermark to this corner. Null clears the override so the default applies. Upload new watermark images in Studio."}},"additionalProperties":false}}}},"responses":{"200":{"description":"Caption and watermark settings the next Render uses, resolved over the Organization default.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"captions":{"type":"object","properties":{"enabled":{"type":["boolean","null"],"description":"Caption visibility. Null lets the Video style decide."},"inherited":{"type":"boolean","description":"True when no caption choice is saved on this item."},"style_id":{"type":["string","null"],"enum":["default","studio","spotlight","signal","velvet","electric","broadcast","mint-label","editorial","outline","afterglow","typewriter","cobalt-card","sunset","paper-label","whisper","scoreboard","berry","cutout","marker","orchid-pill","hot-take","frost","almanac","atomic-age","blueprint","chalkboard","claymation","doodle-explainer","atlas","cartoon-pov","flat-infographic","math-explainer","archive-reel","data-desk","code-rush","crayon","documentary","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard",null],"description":"Caption style. Null uses the Video style's caption style."}},"required":["enabled","inherited","style_id"]},"id":{"type":"string","format":"uuid"},"watermark":{"type":["object","null"],"properties":{"inherited":{"type":"boolean","description":"True when the value comes from the default, not this item."},"position":{"type":"string","enum":["top-left","top-right","bottom-left","bottom-right"]},"source":{"type":"string","enum":["upload","podcast_cover","brand_kit"],"description":"An uploaded image, the Podcast cover (Episodes only), or the logo of the item's Brand Kit."}},"required":["inherited","position","source"],"description":"The custom watermark the next Render shows, if any."}},"required":["captions","id","watermark"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/videos":{"get":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"deprecated":false,"operationId":"listVideos","summary":"List videos","parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Page of videos","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"security":[{"bearerAuth":[]}],"tags":["Videos"],"operationId":"createVideo","summary":"Create a video","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"host_id":{"type":"string","minLength":1,"description":"Narrator Host ID. Required unless host_ids is given. Do not combine with host_ids."},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"],"description":"Narration language code. Defaults to en."},"orientation":{"type":"string","enum":["AUTO","PORTRAIT","LANDSCAPE","SQUARE"],"description":"Output orientation. Omit for AUTO, which follows the product policy."},"prompt":{"type":"string","minLength":1,"maxLength":20000,"description":"Instructions for writing new narration: describe the story, audience, and desired result. Omit it to write from the attached sources alone. To preserve finished narration word for word, use script instead."},"script":{"type":"string","minLength":1,"maxLength":75000,"description":"Finished plain-text narration. Put [Character Name] on its own line before each turn. Speaker labels resolve to saved Characters unless speaker_characters assigns their IDs, and may resolve to at most 4 distinct Characters."},"source_ids":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100,"description":"Sources owned by your organization. Generation waits for processing Sources; missing or failed Sources are rejected."},"speaker_characters":{"type":"array","items":{"type":"object","properties":{"character_id":{"type":"string","minLength":1},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["character_id","label"],"additionalProperties":false},"minItems":1,"maxItems":200,"description":"Optional explicit assignments for a finished script: label as written in [brackets], and character_id from list_characters. Assignments override name matching; unmapped labels still match saved Character names."},"style_id":{"type":"string","enum":["almanac","atomic-age","blueprint","chalkboard","claymation","code-rush","crayon","documentary","doodle-explainer","cartoon-cutout","cartoon-pov","flat-infographic","data-desk","math-explainer","cinematic","archival","archive-reel","atlas","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard-explainer"],"description":"Visual style ID. Omit to use the product's default style."},"background_music":{"type":"boolean","description":"Include background music. Applies to Shorts, under three minutes, and defaults to on."},"host_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":4,"description":"Ordered Host IDs. Supports up to four. Do not combine with host_id."},"target_duration_seconds":{"anyOf":[{"type":"number","enum":[30]},{"type":"number","enum":[60]},{"type":"number","enum":[120]},{"type":"number","enum":[180]},{"type":"number","enum":[300]},{"type":"number","enum":[420]},{"type":"number","enum":[600]},{"type":"number","enum":[900]},{"type":"number","enum":[1200]},{"type":"number","enum":[1500]}],"description":"Target duration in seconds; the finished runtime can differ. 30 or 60 or 120 seconds makes a Short; 180 or more makes a Video. Without one, a script is measured by its narration and a prompt defaults to 300, or the longest length the plan allows under it."}},"additionalProperties":false}}}},"responses":{"202":{"description":"Generation accepted. Check the status URL until generation finishes.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"A finished script names speaker labels with no active saved Character. `reason` is `unresolved_speakers` and `speakers` lists each label; assign them with `speaker_characters` or create the Characters, then retry.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/shorts":{"get":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"deprecated":true,"description":"Deprecated: returns the same Shorts and Videos as List videos.","operationId":"listShorts","summary":"List shorts","parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Page of shorts","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"security":[{"bearerAuth":[]}],"tags":["Shorts"],"operationId":"createShort","summary":"Create a short","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"host_id":{"type":"string","minLength":1,"description":"Narrator Host ID. Required unless host_ids is given. Do not combine with host_ids."},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"],"description":"Narration language code. Defaults to en."},"orientation":{"type":"string","enum":["AUTO","PORTRAIT","LANDSCAPE","SQUARE"],"description":"Output orientation. Omit for AUTO, which follows the product policy."},"prompt":{"type":"string","minLength":1,"maxLength":20000,"description":"Instructions for writing new narration: describe the story, audience, and desired result. Omit it to write from the attached sources alone. To preserve finished narration word for word, use script instead."},"script":{"type":"string","minLength":1,"maxLength":75000,"description":"Finished plain-text narration. Put [Character Name] on its own line before each turn. Speaker labels resolve to saved Characters unless speaker_characters assigns their IDs, and may resolve to at most 4 distinct Characters."},"source_ids":{"type":"array","items":{"type":"string","format":"uuid"},"maxItems":100,"description":"Sources owned by your organization. Generation waits for processing Sources; missing or failed Sources are rejected."},"speaker_characters":{"type":"array","items":{"type":"object","properties":{"character_id":{"type":"string","minLength":1},"label":{"type":"string","minLength":1,"maxLength":200}},"required":["character_id","label"],"additionalProperties":false},"minItems":1,"maxItems":200,"description":"Optional explicit assignments for a finished script: label as written in [brackets], and character_id from list_characters. Assignments override name matching; unmapped labels still match saved Character names."},"style_id":{"type":"string","enum":["almanac","atomic-age","blueprint","chalkboard","claymation","code-rush","crayon","documentary","doodle-explainer","cartoon-cutout","cartoon-pov","flat-infographic","data-desk","math-explainer","cinematic","archival","archive-reel","atlas","flat","gouache","paper-mache","paper-lightbox","pixel-art","retro-comics","sketch","stickman","tier-list","toy-bricks","watercolor","whiteboard-explainer"],"description":"Visual style ID. Omit to use the product's default style."},"background_music":{"type":"boolean","description":"Include background music. Applies to Shorts, under three minutes, and defaults to on."},"host_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":4,"description":"Ordered Host IDs. Supports up to four. Do not combine with host_id."},"target_duration_seconds":{"anyOf":[{"type":"number","enum":[30]},{"type":"number","enum":[60]},{"type":"number","enum":[120]},{"type":"number","enum":[180]},{"type":"number","enum":[300]},{"type":"number","enum":[420]},{"type":"number","enum":[600]},{"type":"number","enum":[900]},{"type":"number","enum":[1200]},{"type":"number","enum":[1500]}],"description":"Target duration in seconds; the finished runtime can differ. 30 or 60 or 120 seconds makes a Short; 180 or more makes a Video. Without one, a script is measured by its narration and a prompt defaults to 30, or the longest length the plan allows under it."}},"additionalProperties":false}}}},"responses":{"202":{"description":"Generation accepted. Check the status URL until generation finishes.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["short","video"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"422":{"description":"A finished script names speaker labels with no active saved Character. `reason` is `unresolved_speakers` and `speakers` lists each label; assign them with `speaker_characters` or create the Characters, then retry.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voiceovers":{"get":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"deprecated":false,"operationId":"listVoiceovers","summary":"List voiceovers","parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"}],"responses":{"200":{"description":"Page of voiceovers","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["voiceover"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}},"post":{"security":[{"bearerAuth":[]}],"tags":["Voiceovers"],"operationId":"createVoiceover","summary":"Create a voiceover","parameters":[{"schema":{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x21-\\x7e]+$/u","description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request."},"required":false,"description":"Optional key for one logical generation command. Reuse the same key and input after a lost or uncertain response. After a proven rejection before work starts, follow recovery.idempotency_key. Omit it to start a new generation on every request.","name":"idempotency-key","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"host_id":{"type":"string","minLength":1,"description":"Narrator Host ID. Required unless host_ids is given. Do not combine with host_ids."},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"],"description":"Narration language code. Defaults to en."},"orientation":{"type":"string","enum":["AUTO","PORTRAIT","LANDSCAPE","SQUARE"],"description":"Output orientation. Omit for AUTO, which follows the product policy."},"captions_enabled":{"type":"boolean","default":false,"description":"Show narration captions."},"direction":{"type":"string","maxLength":4000,"description":"Optional narration instructions for the uploaded visuals."},"host_ids":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"maxItems":4,"description":"Ordered Voiceover Host IDs. Supports up to four. Generation assigns each paragraph to one of them; reassign paragraphs in the editor. Do not combine with host_id."},"source_ids":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"maxItems":10,"description":"Uploaded document or image Sources, in presentation order."},"target_duration_seconds":{"anyOf":[{"type":"number","enum":[180]},{"type":"number","enum":[300]},{"type":"number","enum":[420]},{"type":"number","enum":[600]},{"type":"number","enum":[900]},{"type":"number","enum":[1200]},{"type":"number","enum":[1800]},{"type":"number","enum":[2700]},{"type":"number","enum":[3600]}],"description":"Supported narration duration. Omit for automatic duration based on source content."},"visual_motion":{"type":"string","enum":["auto","dynamic","static"],"default":"auto","description":"Zoom effect. Auto zooms image sources and holds document pages still, dynamic zooms every visual, static zooms none."}},"required":["source_ids"],"additionalProperties":false}}}},"responses":{"202":{"description":"Generation accepted. Check the status URL until generation finishes.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"background_music":{"type":"boolean"},"created_at":{"type":"string"},"error":{"type":["string","null"]},"generation_id":{"type":["string","null"]},"host_id":{"type":["string","null"]},"host_ids":{"type":["array","null"],"items":{"type":"string"}},"id":{"type":"string","format":"uuid"},"language":{"type":"string","enum":["en","es","fr","hi","pt","zh","de","ja","ar","ru","ko","id","it","nl","tr","pl","sv","fil","ms","ro","uk","el","cs","da","fi","no","bg","hr","sk","ta","ace","af","ak","sq","am","hy","as","awa","az","ban","bjn","ba","eu","be","bem","bn","bho","bs","bug","my","yue","ca","ckb","hne","ny","crh","dyu","dz","et","gl","lg","ka","gn","gu","ht","ha","he","hu","is","ig","ga","jv","kab","kam","kn","ks","kk","km","ki","rw","kg","ky","lo","ltg","lv","lt","lb","mk","mag","mai","ml","mt","mni","mr","min","lus","mn","ne","nso","or","pag","ps","fa","pa","sat","sr","sd","si","sl","so","sw","ss","tg","te","th","ti","ur","ug","uz","vi","cy"]},"object":{"type":"string","enum":["voiceover"]},"orientation":{"type":"string","enum":["LANDSCAPE","PORTRAIT","SQUARE"]},"phase":{"type":["string","null"]},"status":{"type":"string","enum":["idle","generating","completed","failed"]},"studio_url":{"type":"string","format":"uri"},"style_id":{"type":"string"},"target_duration_seconds":{"type":["number","null"],"description":"Requested target length in seconds, a generation input. The finished runtime can differ."},"title":{"type":"string"},"updated_at":{"type":"string"}},"required":["background_music","created_at","error","generation_id","host_id","host_ids","id","language","object","orientation","phase","status","studio_url","style_id","target_duration_seconds","title","updated_at"]}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"415":{"description":"Request `Content-Type` is not supported for this endpoint.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voices":{"get":{"operationId":"listVoices","security":[{"bearerAuth":[]}],"summary":"List voices","tags":["Voices"],"parameters":[{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":64,"description":"Exact accent name, case-insensitive, such as Irish or Northern Irish."},"required":false,"description":"Exact accent name, case-insensitive, such as Irish or Northern Irish.","name":"accent","in":"query"},{"schema":{"type":"string"},"required":false,"name":"gender","in":"query"},{"schema":{"type":"string","pattern":"^[a-zA-Z]{2,3}$/u"},"required":false,"name":"language","in":"query"},{"schema":{"type":"string","minLength":1,"maxLength":200,"description":"Plain-text search, such as \"irish male storyteller\". A voice matches when any word appears in its description, accent, or style tags; male, female, man, and woman filter by gender instead. Results are not ranked by match count. Up to 8 words. Not semantic."},"required":false,"description":"Plain-text search, such as \"irish male storyteller\". A voice matches when any word appears in its description, accent, or style tags; male, female, man, and woman filter by gender instead. Results are not ranked by match count. Up to 8 words. Not semantic.","name":"query","in":"query"},{"schema":{"type":"string"},"required":false,"name":"voice_type","in":"query"}],"responses":{"200":{"description":"Page of voices","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListVoicesResponse"}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}},"/v1/voices/{voice_id}":{"get":{"operationId":"getVoice","security":[{"bearerAuth":[]}],"summary":"Get a voice","tags":["Voices"],"parameters":[{"schema":{"type":"string","pattern":"^[1-9]\\d*$/u","description":"Voice ID (positive integer).","example":"30142"},"required":true,"description":"Voice ID (positive integer).","in":"path","name":"voice_id"}],"responses":{"200":{"description":"Voice","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/VoiceRow"}},"required":["data"]}}}},"400":{"description":"Validation failed or malformed request.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Missing or invalid API key.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Authenticated, but this API key does not have access to this resource.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Resource not found.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Rate limit exceeded. Wait `Retry-After` seconds before retrying; `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` describe the window.","headers":{"RateLimit-Limit":{"description":"Requests allowed in the current window.","schema":{"type":"integer"}},"RateLimit-Remaining":{"description":"Requests left in the current window.","schema":{"minimum":0,"type":"integer"}},"RateLimit-Reset":{"description":"Seconds until the current window resets.","schema":{"minimum":0,"type":"integer"}},"Retry-After":{"description":"Seconds to wait before retrying.","schema":{"minimum":1,"type":"integer"}}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"500":{"description":"Internal server error.","content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}}}}},"webhooks":{}}