REST API for generating AI presenter videos — blueprint/template-based and dynamic scene-based creation, voice previews, subtitles, metadata, analytics, and signed webhooks.
{"openapi":"3.1.0","info":{"title":"sizzle-server","version":"1.0.0"},"servers":[{"url":"/api/v1"}],"paths":{"/videos":{"get":{"tags":["videos"],"summary":"List Videos","description":"Get videos","operationId":"list_videos_videos_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VideoResponse"},"type":"array","title":"Response List Videos Videos Get"}}}}},"security":[{"APIKeyHeader":[]}]},"post":{"tags":["videos"],"summary":"Create Video","description":"Create a video based on a source draft or a recipe_id","operationId":"create_video_videos_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InitiatorVideoRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/videos/{video_id}":{"get":{"tags":["videos"],"summary":"Get Video By Id","description":"Get video by id","operationId":"get_video_by_id_videos__video_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Video Id"},"name":"video_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]},"delete":{"tags":["videos"],"summary":"Delete Video By Id","description":"Delete video by id","operationId":"delete_video_by_id_videos__video_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Video Id"},"name":"video_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/videos/{video_id}/subtitles":{"post":{"tags":["videos"],"summary":"Create Subtitles","description":"Create subtitles","operationId":"create_subtitles_videos__video_id__subtitles_post","parameters":[{"required":true,"schema":{"type":"string","title":"Video Id"},"name":"video_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitlesApiRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubtitlesApiResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/videos/{video_id}/metadata":{"get":{"tags":["videos"],"summary":"Get Video Metadata","description":"Get video by id","operationId":"get_video_metadata_videos__video_id__metadata_get","parameters":[{"required":true,"schema":{"type":"string","title":"Video Id"},"name":"video_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VideoMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/voice-preview":{"post":{"tags":["voice-preview"],"summary":"Create Audio Preview","description":"create a voice preview based on a source draft","operationId":"create_audio_preview_voice_preview_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VoicePreviewRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateVoicePreviewResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/voice-preview/{task_id}":{"get":{"tags":["voice-preview"],"summary":"Get Voice Preview","operationId":"get_voice_preview_voice_preview__task_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Task Id"},"name":"task_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskProgressResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/examples":{"post":{"tags":["general"],"summary":"Create Example","description":"create examples","operationId":"create_example_examples_post","parameters":[{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExampleRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/examples/create-video":{"get":{"tags":["general"],"summary":"Create Video Call Example","description":"get crate video call example","operationId":"create_video_call_example_examples_create_video_get","parameters":[{"required":true,"schema":{"type":"string","title":"Draft Id"},"name":"draft_id","in":"query"},{"required":false,"schema":{"type":"string","title":"Example Type","default":"create"},"name":"example_type","in":"query"},{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExampleResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/analytics/summary":{"get":{"tags":["general"],"summary":"Get Summary","description":"get analytics summary","operationId":"get_summary_analytics_summary_get","parameters":[{"required":false,"schema":{"allOf":[{"$ref":"#/components/schemas/UsageBreakdown"}],"default":"monthly"},"name":"breakdown","in":"query"},{"required":false,"schema":{"type":"string","format":"date","title":"From Date"},"name":"from_date","in":"query"},{"required":false,"schema":{"type":"string","format":"date","title":"To Date"},"name":"to_date","in":"query"},{"required":false,"schema":{"type":"string","title":"Correlation Id"},"name":"correlation_id","in":"query"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UsageResponse"},"type":"array","title":"Response Get Summary Analytics Summary Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyHeader":[]}]}},"/keys":{"get":{"tags":["keys"],"summary":"Get Keys Ids","description":"Get token by token id","operationId":"get_keys_ids_keys_get","parameters":[{"required":false,"schema":{"type":"string","title":"As Client"},"name":"as_client","in":"query"},{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiIdsResponse"},"type":"array","title":"Response Get Keys Ids Keys Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["keys"],"summary":"Generate Api Key","description":"generate a api key for the current user","operationId":"generate_api_key_keys_post","parameters":[{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/keys/{key_id}":{"delete":{"tags":["keys"],"summary":"Revoke Api Key","description":"Archive specific draft's scene","operationId":"revoke_api_key_keys__key_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Key Id"},"name":"key_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/playground/generate":{"post":{"tags":["playground"],"summary":"Generate","description":"generate video","operationId":"generate_playground_generate_post","parameters":[{"required":false,"schema":{"$ref":"#/components/schemas/RealsPlatform"},"name":"reals-platform","in":"header"},{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaygroundRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaygroundResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/playground/videos":{"get":{"tags":["playground"],"summary":"Get Videos","description":"get videos","operationId":"get_videos_playground_videos_get","parameters":[{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/PlaygroundResponse"},"type":"array","title":"Response Get Videos Playground Videos Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/playground/videos/{video_id}/download":{"get":{"tags":["playground"],"summary":"Download Video","description":"download video","operationId":"download_video_playground_videos__video_id__download_get","parameters":[{"required":true,"schema":{"type":"string","title":"Video Id"},"name":"video_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PlaygroundDownloadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/playground/videos/{video_id}/share":{"put":{"tags":["playground"],"summary":"Share Video","description":"share video","operationId":"share_video_playground_videos__video_id__share_put","parameters":[{"required":true,"schema":{"type":"string","title":"Video Id"},"name":"video_id","in":"path"},{"required":false,"schema":{"type":"string","title":"Workspace-Id"},"name":"workspace-id","in":"header"},{"required":false,"schema":{"type":"string","title":"Team-Id"},"name":"team-id","in":"header"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/webhooks":{"get":{"tags":["webhook"],"summary":"Get Webhooks","description":"get all webhooks","operationId":"get_webhooks_webhooks_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/WebhookResponse"},"type":"array","title":"Response Get Webhooks Webhooks Get"}}}}},"security":[{"HTTPBearer":[]}]},"post":{"tags":["webhook"],"summary":"Create Webhook","description":"Create webhook","operationId":"create_webhook_webhooks_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/webhooks/{webhook_id}":{"get":{"tags":["webhook"],"summary":"Get Webhook","description":"get one webhook","operationId":"get_webhook_webhooks__webhook_id__get","parameters":[{"required":true,"schema":{"type":"string","title":"Webhook Id"},"name":"webhook_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"put":{"tags":["webhook"],"summary":"Update Webhook","description":"update webhook","operationId":"update_webhook_webhooks__webhook_id__put","parameters":[{"required":true,"schema":{"type":"string","title":"Webhook Id"},"name":"webhook_id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]},"delete":{"tags":["webhook"],"summary":"Delete Webhook","description":"delete webhook","operationId":"delete_webhook_webhooks__webhook_id__delete","parameters":[{"required":true,"schema":{"type":"string","title":"Webhook Id"},"name":"webhook_id","in":"path"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/webhooks/{webhook_id}/secret":{"put":{"tags":["webhook"],"summary":"Regenerate Webhook Secret","description":"regenerate webhook secret","operationId":"regenerate_webhook_secret_webhooks__webhook_id__secret_put","parameters":[{"required":true,"schema":{"type":"string","title":"Webhook Id"},"name":"webhook_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/webhooks/{webhook_id}/pause":{"put":{"tags":["webhook"],"summary":"Toggle Pause State","description":"pause or unpause webhook","operationId":"toggle_pause_state_webhooks__webhook_id__pause_put","parameters":[{"required":true,"schema":{"type":"string","title":"Webhook Id"},"name":"webhook_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}},"/webhooks/{webhook_id}/toggle-status":{"put":{"tags":["webhook"],"summary":"Toggle Active State","description":"toggle webhook status between active and inactive states","operationId":"toggle_active_state_webhooks__webhook_id__toggle_status_put","parameters":[{"required":true,"schema":{"type":"string","title":"Webhook Id"},"name":"webhook_id","in":"path"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"HTTPBearer":[]}]}}},"components":{"schemas":{"ApiIdsResponse":{"properties":{"id":{"type":"string","title":"Id"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"}},"type":"object","required":["id","created_at","updated_at"],"title":"ApiIdsResponse"},"ApiKeyResponse":{"properties":{"id":{"type":"string","title":"Id"},"key":{"type":"string","title":"Key"},"created_at":{"type":"string","title":"Created At"},"updated_at":{"type":"string","title":"Updated At"}},"type":"object","required":["id","key","created_at","updated_at"],"title":"ApiKeyResponse"},"CreateExampleRequest":{"properties":{"type":{"$ref":"#/components/schemas/ExampleTypes"},"draft_id":{"type":"string","title":"Draft Id"},"workflow_id":{"type":"string","title":"Workflow Id"}},"type":"object","required":["type"],"title":"CreateExampleRequest"},"CreateVoicePreviewResponse":{"properties":{"id":{"type":"string","title":"Id"},"transcript":{"type":"string","title":"Transcript"},"voice_id":{"type":"string","title":"Voice Id"},"req_id":{"type":"string","title":"Req Id"},"status":{"allOf":[{"$ref":"#/components/schemas/StatusTypes"}],"default":"in_progress"}},"type":"object","required":["id","transcript","voice_id","req_id"],"title":"CreateVoicePreviewResponse"},"EventName":{"type":"string","enum":["video.ready","video.failed"],"title":"EventName","description":"An enumeration."},"ExampleResponse":{"properties":{"curl":{"type":"string","title":"Curl"},"json_request":{"type":"object","title":"Json Request"}},"type":"object","required":["curl","json_request"],"title":"ExampleResponse"},"ExampleTypes":{"type":"string","enum":["create","override","create_video_from_workflow"],"title":"ExampleTypes","description":"An enumeration."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"InitiatorVideoRequest":{"oneOf":[{"$ref":"#/components/schemas/OverrideVideoRequest"},{"$ref":"#/components/schemas/NewVideoRequest"},{"$ref":"#/components/schemas/WorkflowVideoRequest"}],"title":"InitiatorVideoRequest","discriminator":{"propertyName":"type","mapping":{"override":"#/components/schemas/OverrideVideoRequest","create":"#/components/schemas/NewVideoRequest","workflow":"#/components/schemas/WorkflowVideoRequest"}}},"NewVideoRequest":{"properties":{"type":{"type":"string","enum":["create"],"title":"Type"},"name":{"type":"string","title":"Name","description":"The name of the project created by this request"},"template_id":{"type":"string","title":"Template Id","description":"The id of the recipe your video will be based on."},"folder_id":{"type":"string","title":"Folder Id","description":"The id of the folder your video will be based on."},"palette_id":{"type":"string","title":"Palette Id","description":"The palette_id of a color-palette you would like to use instead of the source project one. if no value is given, the source projects color-palette will be used."},"character_id":{"type":"string","title":"Character Id","description":"The character_id of a character you would like to use instead of the source projects one. if no value is given, the source projects character will be used."},"voice_id":{"type":"string","title":"Voice Id","description":"The id of a voice you would like to use instead of the source projects one. if no value is given, the source projects voice will be used."},"scenes":{"items":{"$ref":"#/components/schemas/NewVideoScene"},"type":"array","minItems":1,"title":"Scenes","description":"Each object in this array will represent a scene in the final video. the video will be generated based on this arrays order (the first object in this array will represent the first scene in the video etc.). The length of this array must be equal to the number of the source projects scenes. "},"global_media_elements":{"items":{"$ref":"#/components/schemas/SceneMediaAttribute"},"type":"array","title":"Global Media Elements","description":"The array will contain global media values of the video"},"palette":{"items":{"$ref":"#/components/schemas/RequestPalette"},"type":"array","title":"Palette"},"metadata":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"type":"object","title":"Metadata","description":"request metadata"},"correlation_id":{"type":"string","maxLength":100,"title":"Correlation Id","description":"request correlation id"}},"type":"object","required":["type","template_id","character_id","voice_id","scenes"],"title":"NewVideoRequest"},"NewVideoScene":{"properties":{"name":{"type":"string","title":"Name","description":"The name of this scene."},"type":{"type":"string","enum":["create_scene"],"title":"Type","default":"create_scene"},"layout_id":{"type":"string","title":"Layout Id","description":"The layout on the video"},"media_elements":{"items":{"$ref":"#/components/schemas/SceneMediaAttribute"},"type":"array","title":"Media Elements","description":"This array will contain image/video urls which will be used as this scenes media attributes such as background images and videos. If the number of media assets in this array exceeds the current layouts amount of assets, the extra assets will be dismissed. If the number of media assets provided in this array is smaller then the amount of assets the layout supports, the base projects default values will be chosen"},"texts_elements":{"items":{"$ref":"#/components/schemas/SceneTextAttribute"},"type":"array","title":"Texts Elements","description":"This array will contain text values which will be used as this scenes text attributes such as titles. If the number of text assets in this array exceeds the current layouts amount of text assets, the extra assets will be dismissed.If the number of media assets provided in this array is smaller then the amount of assets the layout supports, the base projects default values will be chosen "},"transcript":{"type":"string","maxLength":1000,"title":"Transcript","description":"This scenes transcript. must contain less than 500 characters"},"voice_recording_url":{"type":"string","title":"Voice Recording Url","description":"This scenes voice recording url."}},"type":"object","required":["name","layout_id"],"title":"NewVideoScene"},"OverrideVideoRequest":{"properties":{"type":{"type":"string","enum":["override"],"title":"Type"},"name":{"type":"string","title":"Name","description":"The name of the project created by this request"},"source_draft_id":{"type":"string","title":"Source Draft Id","description":"The id of the project your video will be based on."},"recipe_id":{"type":"string","title":"Recipe Id","description":"The id of the recipe your video will be based on."},"folder_id":{"type":"string","title":"Folder Id","description":"The id of the folder your video will be based on."},"palette_id":{"type":"string","title":"Palette Id","description":"The palette_id of a color-palette you would like to use instead of the source project one. if no value is given, the source projects color-palette will be used."},"character_id":{"type":"string","title":"Character Id","description":"The character_id of a character you would like to use instead of the source projects one. if no value is given, the source projects character will be used."},"voice_id":{"type":"string","title":"Voice Id","description":"The id of a voice you would like to use instead of the source projects one. if no value is given, the source projects voice will be used."},"scenes":{"items":{"$ref":"#/components/schemas/VideoScene"},"type":"array","title":"Scenes","description":"Each object in this array will represent a scene in the final video. the video will be generated based on this arrays order (the first object in this array will represent the first scene in the video etc.). The length of this array must be equal to the number of the source projects scenes. "},"logo_url":{"type":"string","title":"Logo Url","description":"The url of the logo you would like to use instead of the source projects one. if no value is given, the source projects logo will be used."},"metadata":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"boolean"}]},"type":"object","title":"Metadata","description":"request metadata"},"correlation_id":{"type":"string","maxLength":100,"title":"Correlation Id","description":"request correlation id"}},"type":"object","required":["type","scenes"],"title":"OverrideVideoRequest"},"PlaygroundDownloadResponse":{"properties":{"url":{"type":"string","title":"Url"},"status":{"type":"string","title":"Status"}},"type":"object","required":["status"],"title":"PlaygroundDownloadResponse"},"PlaygroundRequest":{"properties":{"title":{"type":"string","title":"Title"},"source_video":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Source Video"},"character_id":{"type":"string","title":"Character Id"},"voice_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Voice Url"},"voice_id":{"type":"string","title":"Voice Id"},"transcript":{"type":"string","title":"Transcript"},"order_id":{"type":"string","title":"Order Id"}},"type":"object","title":"PlaygroundRequest"},"PlaygroundResponse":{"properties":{"id":{"type":"string","title":"Id"},"title":{"type":"string","title":"Title"},"created_at":{"type":"string","title":"Created At"},"req_id":{"type":"string","title":"Req Id"},"source_video":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Source Video"},"character_id":{"type":"string","title":"Character Id"},"voice_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Voice Url"},"voice_id":{"type":"string","title":"Voice Id"},"playback_id":{"type":"string","title":"Playback Id"},"transcript":{"type":"string","title":"Transcript"},"order_id":{"type":"string","title":"Order Id"},"status":{"type":"string","title":"Status"},"progress":{"type":"integer","title":"Progress"}},"type":"object","title":"PlaygroundResponse"},"RealsPlatform":{"type":"string","enum":["mobile","reals","reals_api"],"title":"RealsPlatform","description":"An enumeration."},"RequestPalette":{"properties":{"color":{"type":"string","pattern":"^#?(?:[0-9A-Fa-f]{8}|[0-9A-Fa-f]{6})$","title":"Color"}},"type":"object","required":["color"],"title":"RequestPalette"},"SceneMediaAttribute":{"properties":{"id":{"type":"string","title":"Id"},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"media_id":{"type":"string","title":"Media Id"}},"type":"object","title":"SceneMediaAttribute"},"SceneMetadataResponse":{"properties":{"scene_index":{"type":"integer","title":"Scene Index"},"start_time":{"type":"number","title":"Start Time"},"duration":{"type":"number","title":"Duration"}},"type":"object","required":["scene_index","start_time","duration"],"title":"SceneMetadataResponse"},"SceneTextAttribute":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"SceneTextAttribute"},"StatusTypes":{"type":"string","enum":["in_progress","ready","failed"],"title":"StatusTypes","description":"An enumeration."},"SubtitlesApiRequest":{"properties":{"language_code":{"$ref":"#/components/schemas/SupportedTranslationSubtitlesLanguagesCode"},"format":{"allOf":[{"$ref":"#/components/schemas/SubtitlesFileExtension"}],"default":"vtt"}},"type":"object","required":["language_code"],"title":"SubtitlesApiRequest"},"SubtitlesApiResponse":{"properties":{"language_code":{"$ref":"#/components/schemas/SupportedTranslationSubtitlesLanguagesCode"},"format":{"allOf":[{"$ref":"#/components/schemas/SubtitlesFileExtension"}],"default":"vtt"},"url":{"type":"string","title":"Url"}},"type":"object","required":["language_code","url"],"title":"SubtitlesApiResponse"},"SubtitlesFileExtension":{"type":"string","enum":["vtt","srt"],"title":"SubtitlesFileExtension","description":"An enumeration."},"SupportedTranslationSubtitlesLanguagesCode":{"type":"string","enum":["en","es","de","pt","it","fr","nl","ja","tr","pl","hu","cz","he","zh","hi","ru","ko","ar"],"title":"SupportedTranslationSubtitlesLanguagesCode","description":"An enumeration."},"TaskProgressResponse":{"properties":{"id":{"type":"string","title":"Id"},"req_id":{"type":"string","title":"Req Id"},"status":{"$ref":"#/components/schemas/StatusTypes"},"url":{"type":"string","title":"Url"}},"type":"object","required":["id","req_id","status"],"title":"TaskProgressResponse"},"UpdateWebhookRequest":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Url"},"events":{"items":{"$ref":"#/components/schemas/EventName"},"type":"array"}},"type":"object","required":["name","url"],"title":"UpdateWebhookRequest"},"UsageBreakdown":{"type":"string","enum":["daily","weekly","monthly"],"title":"UsageBreakdown","description":"An enumeration."},"UsageResponse":{"properties":{"day":{"type":"integer","title":"Day"},"week":{"type":"integer","title":"Week"},"month":{"type":"integer","title":"Month"},"year":{"type":"integer","title":"Year"},"videos_created":{"type":"integer","title":"Videos Created"},"total_duration":{"type":"integer","title":"Total Duration"}},"type":"object","required":["videos_created","total_duration"],"title":"UsageResponse"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VariableMapping":{"properties":{"name":{"type":"string","title":"Name"},"variable_id":{"type":"string","title":"Variable Id"},"value":{"type":"string","title":"Value"}},"type":"object","required":["value"],"title":"VariableMapping"},"VideoMetadataResponse":{"properties":{"duration":{"type":"number","title":"Duration"},"scenes_metadata":{"items":{"$ref":"#/components/schemas/SceneMetadataResponse"},"type":"array","title":"Scenes Metadata"}},"type":"object","required":["duration","scenes_metadata"],"title":"VideoMetadataResponse"},"VideoResponse":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"},"status":{"$ref":"#/components/schemas/VideoStatusEnum"},"progress":{"type":"integer","maximum":100.0,"minimum":-1.0,"title":"Progress","description":"The videos rendering progress","default":0},"req_id":{"type":"string","title":"Req Id"},"draft_id":{"type":"string","title":"Draft Id","description":"The id of the project created by this video request"},"source_draft_id":{"type":"string","title":"Source Draft Id"},"recipe_id":{"type":"string","title":"Recipe Id"},"template_id":{"type":"string","title":"Template Id"},"palette_id":{"type":"string","title":"Palette Id","description":"The palette_id used in this video"},"character_id":{"type":"string","title":"Character Id","description":"The character_id used in this video"},"voice_id":{"type":"string
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/hour-one/refs/heads/main/openapi/hour-one-openapi.json