{ "components": { "schemas": { "AInput": { "example": { "actor_id": null, "names": [], "variables": [], "video_instance_id": "00000000-0000-0000-0000-000000000000" }, "properties": { "actor_id": {}, "names": { "items": {}, "type": "array" }, "variables": { "items": {}, "type": "array" }, "video_instance_id": { "type": "string" } }, "title": "AInput", "type": "object" }, "Actor": { "example": { "created_at": "1970-01-01T00:00:00", "id": "00000000-0000-0000-0000-000000000000", "name": "", "sync_actor_id": null, "updated_at": "1970-01-01T00:00:00", "us_accent": false, "user_id": "" }, "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "sync_actor_id": {}, "updated_at": { "type": "string" }, "us_accent": { "type": "boolean" }, "user_id": { "type": "string" } }, "title": "Actor", "type": "object" }, "Audio": { "example": { "actor_id": "00000000-0000-0000-0000-000000000000", "created_at": "1970-01-01T00:00:00", "id": "00000000-0000-0000-0000-000000000000", "name": "", "updated_at": "1970-01-01T00:00:00", "url": "", "user_id": "", "video_instance_id": null }, "properties": { "actor_id": { "type": "string" }, "created_at": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" }, "user_id": { "type": "string" }, "video_instance_id": {} }, "title": "Audio", "type": "object" }, "BHumanApiError": { "properties": { "code": { "example": 401, "type": "integer" }, "result": { "properties": { "error": { "type": "string" } }, "type": "object" } }, "title": "BHumanApiError", "type": "object" }, "BHumanGenerationAccepted": { "properties": { "code": { "example": 200, "type": "integer" }, "result": { "description": "Generated video IDs accepted for processing.", "items": { "format": "uuid", "type": "string" }, "type": "array" } }, "title": "BHumanGenerationAccepted", "type": "object" }, "Campaign": { "example": { "campaign_name": "", "created_at": "1970-01-01T00:00:00", "data_id": null, "data_type": null, "distance_mode": null, "id": "00000000-0000-0000-0000-000000000000", "locked": false, "thumbnail": null, "updated_at": "1970-01-01T00:00:00", "user_id": "", "video_instance_id": "00000000-0000-0000-0000-000000000000", "webhook": null }, "properties": { "campaign_name": { "type": "string" }, "created_at": { "type": "string" }, "data_id": {}, "data_type": {}, "distance_mode": {}, "id": { "type": "string" }, "locked": { "type": "boolean" }, "thumbnail": {}, "updated_at": { "type": "string" }, "user_id": { "type": "string" }, "video_instance_id": { "type": "string" }, "webhook": {} }, "title": "Campaign", "type": "object" }, "CampaignWebhook": { "example": { "created_at": "1970-01-01T00:00:00", "id": "00000000-0000-0000-0000-000000000000", "name": "", "updated_at": "1970-01-01T00:00:00", "user_id": "", "webhook": "" }, "properties": { "created_at": { "type": "string" }, "id": { "type": "string" }, "name": { "type": "string" }, "updated_at": { "type": "string" }, "user_id": { "type": "string" }, "webhook": { "type": "string" } }, "title": "CampaignWebhook", "type": "object" }, "CreateActor": { "properties": { "name": { "type": "string" }, "us_accent": { "nullable": true, "type": "boolean" } }, "required": [ "name" ], "type": "object" }, "CreateActor2": { "properties": { "name": { "type": "string" }, "user_id": { "type": "string" } }, "required": [ "name", "user_id" ], "type": "object" }, "CreateCampaign": { "example": { "campaign_name": "", "distance_mode": null, "video_instance_id": "00000000-0000-0000-0000-000000000000", "webhook": null }, "properties": { "campaign_name": { "type": "string" }, "distance_mode": {}, "video_instance_id": { "type": "string" }, "webhook": {} }, "title": "CreateCampaign", "type": "object" }, "CreateEasySegment": { "example": { "end_time": null, "greetings": null, "start_time": null, "video_instance_id": "00000000-0000-0000-0000-000000000000" }, "properties": { "end_time": {}, "greetings": {}, "start_time": {}, "video_instance_id": { "type": "string" } }, "title": "CreateEasySegment", "type": "object" }, "CreateFolder": { "example": { "name": "", "workspace_id": "00000000-0000-0000-0000-000000000000" }, "properties": { "name": { "type": "string" }, "workspace_id": { "type": "string" } }, "title": "CreateFolder", "type": "object" }, "CreateScript": { "properties": { "about_script": { "type": "string" }, "action": { "type": "string" } }, "required": [ "about_script", "action" ], "type": "object" }, "CreateSegment": { "example": { "campaign_id": null, "end_time": "", "highlight": "", "highlight_ei": 0, "highlight_si": 0, "kind": 0, "name": "", "segment": "", "start_time": "", "video_instance_id": "00000000-0000-0000-0000-000000000000" }, "properties": { "campaign_id": {}, "end_time": { "type": "string" }, "highlight": { "type": "string" }, "highlight_ei": { "type": "integer" }, "highlight_si": { "type": "integer" }, "kind": { "type": "integer" }, "name": { "type": "string" }, "segment": { "type": "string" }, "start_time": { "type": "string" }, "video_instance_id": { "type": "string" } }, "title": "CreateSegment", "type": "object" }, "CreateVideoInstance": { "example": { "actor_id": null, "color_mode": null, "folder_id": null, "greetings": null, "industry": null, "mode": null, "name": "", "processed_video_id": null, "text_to_video": null, "training_url": null, "use_case": null, "video_id": null }, "properties": { "actor_id": {}, "color_mode": {}, "folder_id": {}, "greetings": {}, "industry": {}, "mode": {}, "name": { "type": "string" }, "processed_video_id": {}, "text_to_video": {}, "training_url": {}, "use_case": {}, "video_id": {} }, "title": "CreateVideoInstance", "type": "object" }, "CreateWebhook": { "properties": { "name": { "type": "string" }, "webhook": { "type": "string" } }, "required": [ "name", "webhook" ], "type": "object" }, "ExtractTrainingReq": { "properties": { "duration_secs": { "format": "int32", "nullable": true, "type": "integer" }, "start": { "nullable": true, "type": "string" }, "video_instance_id": { "type": "string" } }, "required": [ "video_instance_id" ], "type": "object" }, "ExtractTrainingRes": { "properties": { "training_url": { "type": "string" } }, "required": [ "training_url" ], "type": "object" }, "Folder": { "example": { "created_at": "1970-01-01T00:00:00", "generated_videos": 0, "id": "00000000-0000-0000-0000-000000000000", "name": "", "parent_videos": 0, "sync_folder_id": null, "updated_at": "1970-01-01T00:00:00", "user_id": "", "workspace_id": "00000000-0000-0000-0000-000000000000" }, "properties": { "created_at": { "type": "string" }, "generated_videos": { "type": "integer" }, "id": { "type": "string" }, "name": { "type": "string" }, "parent_videos": { "type": "integer" }, "sync_folder_id": {}, "updated_at": { "type": "string" }, "user_id": { "type": "string" }, "workspace_id": { "type": "string" } }, "title": "Folder", "type": "object" }, "GeneratedScript": { "properties": { "script": { "type": "string" } }, "required": [ "script" ], "type": "object" }, "GeneratedVideo": { "example": { "actor_id": "00000000-0000-0000-0000-000000000000", "campaign_id": null, "checksum": 0, "color_mode": null, "created_at": "1970-01-01T00:00:00", "estimate_time": null, "execution_name": null, "gif": null, "id": "00000000-0000-0000-0000-000000000000", "message": null, "row_index": null, "share_url": null, "status": "", "text": null, "thumbnail": null, "updated_at": "1970-01-01T00:00:00", "url": null, "user_id": "", "video_id": "00000000-0000-0000-0000-000000000000", "video_instance_id": null }, "properties": { "actor_id": { "type": "string" }, "campaign_id": {}, "checksum": { "type": "integer" }, "color_mode": {}, "created_at": { "type": "string" }, "estimate_time": {}, "execution_name": {}, "gif": {}, "id": { "type": "string" }, "message": {}, "row_index": {}, "share_url": {}, "status": { "type": "string" }, "text": {}, "thumbnail": {}, "updated_at": { "type": "string" }, "url": {}, "user_id": { "type": "string" }, "video_id": { "type": "string" }, "video_instance_id": {} }, "title": "GeneratedVideo", "type": "object" }, "GeneratedVideoForPaidUser": { "example": { "campaign_id": null, "campaign_name": null, "created_at": "1970-01-01T00:00:00", "email": "", "first_name": "", "id": "00000000-0000-0000-0000-000000000000", "last_name": "", "plan_id": null, "reviewer": null, "reviewer1": null, "share_url": null, "thumbnail": null, "url": null, "user_id": "", "video_instance_id": null }, "properties": { "campaign_id": {}, "campaign_name": {}, "created_at": { "type": "string" }, "email": { "type": "string" }, "first_name": { "type": "string" }, "id": { "type": "string" }, "last_name": { "type": "string" }, "plan_id": {}, "reviewer": {}, "reviewer1": {}, "share_url": {}, "thumbnail": {}, "url": {}, "user_id": { "type": "string" }, "video_instance_id": {} }, "title": "GeneratedVideoForPaidUser", "type": "object" }, "GeneratedVideos": { "properties": { "total": { "format": "int64", "type": "integer" }, "videos": { "items": { "$ref": "#/components/schemas/GeneratedVideo" }, "type": "array" } }, "required": [ "total", "videos" ], "type": "object" }, "ImportSpeakeasyProjectRequest": { "properties": { "project_id": { "type": "string" }, "workspace_id": { "nullable": true, "type": "string" } }, "required": [ "project_id" ], "type": "object" }, "ImportedSpeakeasyVideoInstance": { "example": { "actor_id": null, "color_mode": null, "created_at": "1970-01-01T00:00:00", "folder_id": "00000000-0000-0000-0000-000000000000", "greetings": "", "id": "00000000-0000-0000-0000-000000000000", "industry": 0, "mode": 0, "name": "", "processed_video_id": null, "product_id": null, "speakeasy_script_content": null, "text_to_video": false, "thumbnail": null, "training_url": null, "updated_at": "1970-01-01T00:00:00", "use_case": null, "user_id": "", "variable_timing_config": null, "video_distance_execution_name": null, "video_distance_status": null, "video_id": null, "video_percent_of_face": null, "videos_preview_flag": null, "voice_config": null }, "properties": { "actor_id": {}, "color_mode": {}, "created_at": { "type": "string" }, "folder_id": { "type": "string" }, "greetings": { "type": "string" }, "id": { "type": "string" }, "industry": { "type": "integer" }, "mode": { "type": "integer" }, "name": { "type": "string" }, "processed_video_id": {}, "product_id": {}, "speakeasy_script_content": {}, "text_to_video": { "type": "boolean" }, "thumbnail": {}, "training_url": {}, "updated_at": { "type": "string" }, "use_case": {}, "user_id": { "type": "string" }, "variable_timing_config": {}, "video_distance_execution_name": {}, "video_distance_status": {}, "video_id": {}, "video_percent_of_face": {}, "videos_preview_flag": {}, "voice_config": {} }, "type": "object" }, "MonthlyMedian": { "properties": { "percentile_cont": { "format": "double", "nullable": true, "type": "number" }, "weekly": { "format": "double", "nullable": true, "type": "number" }, "yearly": { "format": "double", "nullable": true, "type": "number" } }, "type": "object" }, "NewPipelineWebhook": { "example": { "error": null, "execution_name": null, "id": "", "kind": "" }, "properties": { "error": {}, "execution_name": {}, "id": { "type": "string" }, "kind": { "type": "string" } }, "title": "NewPipelineWebhook", "type": "object" }, "OInput": { "example": { "campaign_id": "00000000-0000-0000-0000-000000000000", "email": "", "names": [] }, "properties": { "campaign_id": { "type": "string" }, "email": { "type": "string" }, "names": { "items": {}, "type": "array" } }, "title": "OInput", "type": "object" }, "PInput": { "example": { "actor_id": "00000000-0000-0000-0000-000000000000", "assets": [ [ "https://example.com/listing-photo.jpg", "https://example.com/market-chart.png" ] ], "audio_start_seconds": [ 0.0 ], "audio_window_anchor": [ "start" ], "audio_window_end_seconds": [ 4.2 ], "audio_window_fit": [ "stretch" ], "backgrounds": [ { "config": { "audio": false, "blend": 0.1, "brightness": 1.0, "color": "00ff00", "mode": "none", "position": "bottom-right", "scale": 0.42, "similarity": 0.1 }, "end": 5.5, "kind": "link", "name": "listing_photo", "start": 2.0 } ], "callback_url": "https://example.com/bhuman-callback", "campaign_id": "00000000-0000-0000-0000-000000000000", "campaign_result_ids": [ 123 ], "enable_lipsync": true, "filter_complex": "", "generation_mode": "auto", "lipsync": true, "names": [ [ "Michael" ] ], "variable_start_times": { "name": 1.2 }, "variables": [ "name" ], "words": [ { "end": 1.7, "start": 1.2, "word": "Michael" } ] }, "properties": { "actor_id": { "type": "string" }, "assets": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "audio_start_seconds": { "items": { "type": "number" }, "type": "array" }, "audio_window_anchor": { "items": { "type": "string" }, "type": "array" }, "audio_window_end_seconds": { "items": { "type": "number" }, "type": "array" }, "audio_window_fit": { "items": { "type": "string" }, "type": "array" }, "backgrounds": { "items": { "properties": { "config": { "properties": { "audio": { "type": "boolean" }, "blend": { "type": "number" }, "brightness": { "type": "number" }, "color": { "type": "string" }, "mode": { "type": "string" }, "position": { "type": "string" }, "scale": { "type": "number" }, "similarity": { "type": "number" } }, "type": "object" }, "end": { "type": "number" }, "kind": { "type": "string" }, "name": { "type": "string" }, "start": { "type": "number" } }, "type": "object" }, "type": "array" }, "callback_url": { "type": "string" }, "campaign_id": { "type": "string" }, "campaign_result_ids": { "items": { "type": "integer" }, "type": "array" }, "enable_lipsync": { "type": "boolean" }, "filter_complex": { "type": "string" }, "generation_mode": { "type": "string" }, "lipsync": { "type": "boolean" }, "names": { "items": { "items": { "type": "string" }, "type": "array" }, "type": "array" }, "variable_start_times": { "properties": { "name": { "type": "number" } }, "type": "object" }, "variables": { "items": { "type": "string" }, "type": "array" }, "words": { "items": { "properties": { "end": { "type": "number" }, "start": { "type": "number" }, "word": { "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "PabblyInput": { "example": { "callback_url": "https://example.com/bhuman-callback", "campaign_id": "00000000-0000-0000-0000-000000000000", "variables": { "listing_photo": "https://example.com/listing-photo.jpg", "name": "Michael" } }, "properties": { "callback_url": { "type": "string" }, "campaign_id": { "type": "string" }, "variables": { "properties": { "listing_photo": { "type": "string" }, "name": { "type": "string" } }, "type": "object" } }, "type": "object" }, "PipelineCompletionCallback": { "description": "Body posted to callback_url when a structured campaign render finishes.", "properties": { "campaign_id": { "format": "uuid", "type": "string" }, "campaign_result_id": { "nullable": true, "type": "integer" }, "gif": { "format": "uri", "type": "string" }, "id": { "format": "uuid", "type": "string" }, "status": { "example": "success", "type": "string" }, "thumbnail": { "format": "uri", "type": "string" }, "url": { "description": "Share page URL for the generated video.", "format": "uri", "type": "string" }, "video_url": { "format": "uri", "type": "string" } }, "title": "PipelineCompletionCallback", "type": "object" }, "PostPutAudio": { "example": { "actor_id": "00000000-0000-0000-0000-000000000000", "name": "", "url": "", "video_instance_id": null }, "properties": { "actor_id": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" }, "video_instance_id": {} }, "title": "PostPutAudio", "type": "object" }, "RequiredId": { "example": { "id": "00000000-0000-0000-0000-000000000000" }, "properties": { "id": { "type": "string" } }, "title": "RequiredId", "type": "object" }, "ReviewOption": { "properties": { "email": { "type": "string" }, "first_name": { "type": "string" }, "options": { "type": "string" }, "share_url": { "type": "string" } }, "required": [ "email", "first_name", "options", "share_url" ], "type": "object" }, "Segment": { "example": { "campaign_id": null, "created_at": "1970-01-01T00:00:00", "end_time": "", "highlight": "", "highlight_ei": 0, "highlight_si": 0, "id": "00000000-0000-0000-0000-000000000000", "kind": 0, "locked": false, "name": "", "segment": "", "start_time": "", "updated_at": "1970-01-01T00:00:00", "user_id": "", "video_instance_id": "00000000-0000-0000-0000-000000000000", "voice_config": null }, "properties": { "campaign_id": {}, "created_at": { "type": "string" }, "end_time": { "type": "string" }, "highlight": { "type": "string" }, "highlight_ei": { "type": "integer" }, "highlight_si": { "type": "integer" }, "id": { "type": "string" }, "kind": { "type": "integer" }, "locked": { "type": "boolean" }, "name": { "type": "string" }, "segment": { "type": "string" }, "start_time": { "type": "string" }, "updated_at": { "type": "string" }, "user_id": { "type": "string" }, "video_instance_id": { "type": "string" }, "voice_config": {} }, "title": "Segment", "type": "object" }, "SegmentAudio": { "properties": { "audio": { "nullable": true, "type": "string" }, "name": { "type": "string" }, "segment": { "type": "string" }, "variable": { "type": "string" } }, "required": [ "name", "segment", "variable" ], "type": "object" }, "SegmentAudios": { "properties": { "names": { "items": { "items": { "$ref": "#/components/schemas/SegmentAudio" }, "type": "array" }, "type": "array" } }, "required": [ "names" ], "type": "object" }, "SegmentOptionalId": { "example": { "all": null, "campaign_id": null, "id": null, "video_instance_id": null }, "properties": { "all": {}, "campaign_id": {}, "id": {}, "video_instance_id": {} }, "title": "SegmentOptionalId", "type": "object" }, "SpeakeasyProject": { "properties": { "created_at": { "nullable": true, "type": "string" }, "effective_status": { "nullable": true, "type": "string" }, "effective_updated_at": { "nullable": true, "type": "string" }, "effective_video_url": { "nullable": true, "type": "string" }, "id": { "type": "string" }, "name": { "nullable": true, "type": "string" }, "presenter_image_url": { "nullable": true, "type": "string" }, "status": { "nullable": true, "type": "string" }, "thumbnail": { "nullable": true, "type": "string" }, "thumbnail_url": { "nullable": true, "type": "string" }, "updated_at": { "nullable": true, "type": "string" }, "video_url": { "nullable": true, "type": "string" } }, "required": [ "id" ], "type": "object" }, "SpeakeasyProjects": { "properties": { "account_exists": { "type": "boolean" }, "projects": { "items": { "$ref": "#/components/schemas/SpeakeasyProject" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "account_exists", "projects", "total" ], "type": "object" }, "SyncActor": { "example": { "actor_id": "00000000-0000-0000-0000-000000000000", "user_id": "" }, "properties": { "actor_id": { "type": "string" }, "user_id": { "type": "string" } }, "title": "SyncActor", "type": "object" }, "SyncFolder": { "example": { "folder_id": "00000000-0000-0000-0000-000000000000", "user_id": "" }, "properties": { "folder_id": { "type": "string" }, "user_id": { "type": "string" } }, "title": "SyncFolder", "type": "object" }, "TSInput": { "example": { "assets": null, "audio_start_seconds": null, "audio_window_anchor": null, "audio_window_end_seconds": null, "audio_window_fit": null, "backgrounds": null, "callback_url": null, "campaign_result_ids": null, "distance_mode": null, "enable_lipsync": null, "enable_subtitles": null, "filter_complex": null, "generation_mode": null, "lipsync": null, "names": [], "variable_start_times": null, "variables": [], "video_instance_id": "00000000-0000-0000-0000-000000000000", "words": null }, "properties": { "assets": {}, "audio_start_seconds": {}, "audio_window_anchor": {}, "audio_window_end_seconds": {}, "audio_window_fit": {}, "backgrounds": {}, "callback_url": {}, "campaign_result_ids": {}, "distance_mode": {}, "enable_lipsync": {}, "enable_subtitles": {}, "filter_complex": {}, "generation_mode": {}, "lipsync": {}, "names": { "items": {}, "type": "array" }, "variable_start_times": {}, "variables": { "items": {}, "type": "array" }, "video_instance_id": { "type": "string" }, "words": {} }, "title": "TSInput", "type": "object" }, "UpdateActor": { "example": { "id": "00000000-0000-0000-0000-000000000000", "name": "" }, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "UpdateActor", "type": "object" }, "UpdateCampaign": { "example": { "campaign_name": null, "data_id": null, "data_type": null, "distance_mode": null, "id": "00000000-0000-0000-0000-000000000000", "webhook": null }, "properties": { "campaign_name": {}, "data_id": {}, "data_type": {}, "distance_mode": {}, "id": { "type": "string" }, "webhook": {} }, "title": "UpdateCampaign", "type": "object" }, "UpdateFolder": { "example": { "id": "00000000-0000-0000-0000-000000000000", "name": "" }, "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "title": "UpdateFolder", "type": "object" }, "UpdateSegment": { "example": { "campaign_id": null, "end_time": null, "highlight": null, "highlight_ei": null, "highlight_si": null, "id": "00000000-0000-0000-0000-000000000000", "name": null, "segment": null, "start_time": null }, "properties": { "campaign_id": {}, "end_time": {}, "highlight": {}, "highlight_ei": {}, "highlight_si": {}, "id": { "type": "string" }, "name": {}, "segment": {}, "start_time": {} }, "title": "UpdateSegment", "type": "object" }, "UpdateVideoinstance": { "example": { "actor_id": null, "color_mode": null, "greetings": null, "id": "00000000-0000-0000-0000-000000000000", "industry": null, "mode": null, "name": null, "processed_video_id": null, "product_id": null, "text_to_video": null, "training_url": null, "use_case": null, "variable_timing_config": null, "video_id": null, "videos_preview_flag": null }, "properties": { "actor_id": {}, "color_mode": {}, "greetings": {}, "id": { "type": "string" }, "industry": {}, "mode": {}, "name": {}, "processed_video_id": {}, "product_id": {}, "text_to_video": {}, "training_url": {}, "use_case": {}, "variable_timing_config": {}, "video_id": {}, "videos_preview_flag": {} }, "title": "UpdateVideoinstance", "type": "object" }, "UpdateVoiceConfig": { "example": { "id": "00000000-0000-0000-0000-000000000000", "voice_config": "" }, "properties": { "id": { "type": "string" }, "voice_config": { "type": "string" } }, "title": "UpdateVoiceConfig", "type": "object" }, "VDInput": { "example": { "variables": [], "video_instance_id": "00000000-0000-0000-0000-000000000000" }, "properties": { "variables": { "items": {}, "type": "array" }, "video_instance_id": { "type": "string" } }, "title": "VDInput", "type": "object" }, "VRInput": { "example": { "assets": null, "backgrounds": null, "callback_url": null, "campaign_result_ids": null, "distance_mode": null, "filter_complex": null, "names": [], "variables": [], "video_instance_id": "00000000-0000-0000-0000-000000000000" }, "properties": { "assets": {}, "backgrounds": {}, "callback_url": {}, "campaign_result_ids": {}, "distance_mode": {}, "filter_complex": {}, "names": { "items": {}, "type": "array" }, "variables": { "items": {}, "type": "array" }, "video_instance_id": { "type": "string" } }, "title": "VRInput", "type": "object" }, "VideoInstance": { "example": { "actor_id": null, "color_mode": null, "created_at": "1970-01-01T00:00:00", "folder_id": "00000000-0000-0000-0000-000000000000", "greetings": "", "id": "00000000-0000-0000-0000-000000000000", "industry": 0, "mode": 0, "name": "", "processed_video_id": null, "product_id": null, "text_to_video": false, "thumbnail": null, "training_url": null, "updated_at": "1970-01-01T00:00:00", "use_case": null, "user_id": "", "variable_timing_config": null, "video_distance_execution_name": null, "video_distance_status": null, "video_id": null, "video_percent_of_face": null, "videos_preview_flag": null, "voice_config": null }, "properties": { "actor_id": {}, "color_mode": {}, "created_at": { "type": "string" }, "folder_id": { "type": "string" }, "greetings": { "type": "string" }, "id": { "type": "string" }, "industry": { "type": "integer" }, "mode": { "type": "integer" }, "name": { "type": "string" }, "processed_video_id": {}, "product_id": {}, "text_to_video": { "type": "boolean" }, "thumbnail": {}, "training_url": {}, "updated_at": { "type": "string" }, "use_case": {}, "user_id": { "type": "string" }, "variable_timing_config": {}, "video_distance_execution_name": {}, "video_distance_status": {}, "video_id": {}, "video_percent_of_face": {}, "videos_preview_flag": {}, "voice_config": {} }, "title": "VideoInstance", "type": "object" }, "VideoInstances": { "properties": { "instances": { "items": { "$ref": "#/components/schemas/VideoInstance" }, "type": "array" }, "total": { "format": "int64", "type": "integer" } }, "required": [ "instances", "total" ], "type": "object" } }, "securitySchemes": { "BasicAuth": { "description": "Integration credentials. Use client_id as the username and client_secret as the password. This is the recommended auth mode for GoHighLevel Custom Webhook actions.", "scheme": "basic", "type": "http" }, "Bearer": { "bearerFormat": "JWT", "description": "First-party BHuman user access token.", "scheme": "bearer", "type": "http" } } }, "info": { "description": "Production API for BHuman AI Studio video generation, campaign personalization, CRM-triggered generation, and render callbacks.", "title": "BHuman AI Studio API", "version": "0.2.0" }, "openapi": "3.0.0", "paths": { "/api/ai_studio/actor": { "delete": { "description": "", "operationId": "delete_actor", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequiredId" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"actor\"" ] }, "get": { "description": "", "operationId": "get_actor", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Actor" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"actor\"" ] }, "post": { "description": "", "operationId": "create_actor", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActor" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Actor" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"actor\"" ] }, "put": { "description": "", "operationId": "update_actor", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateActor" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Actor" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"actor\"" ] } }, "/api/ai_studio/audio": { "get": { "description": "", "operationId": "get_audio", "parameters": [ { "in": "query", "name": "actor_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "video_instance_id", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audio" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"audio\"" ] }, "post": { "description": "", "operationId": "post_put_audio", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PostPutAudio" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Audio" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"audio\"" ] } }, "/api/ai_studio/campaign": { "delete": { "description": "", "operationId": "delete_campaign", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"campaign\"" ] }, "get": { "description": "", "operationId": "get_campaign", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"campaign\"" ] }, "post": { "description": "", "operationId": "create_campaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateCampaign" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"campaign\"" ] }, "put": { "description": "", "operationId": "update_campaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateCampaign" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"campaign\"" ] } }, "/api/ai_studio/campaign/retry": { "post": { "description": "", "operationId": "retry_failed_campaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequiredId" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"campaign\"" ] } }, "/api/ai_studio/campaigns": { "get": { "description": "", "operationId": "get_campaigns", "parameters": [ { "in": "query", "name": "video_instance_id", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Campaign" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"campaign\"" ] } }, "/api/ai_studio/create_actor_by_user_id": { "post": { "description": "", "operationId": "create_actor_by_user_id", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateActor2" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Actor" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/easy_segment": { "post": { "description": "", "operationId": "create_easy_segment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateEasySegment" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"segment\"" ] } }, "/api/ai_studio/extract_training_audio": { "post": { "description": "", "operationId": "extract_training_audio", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractTrainingReq" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExtractTrainingRes" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"tools\"" ] } }, "/api/ai_studio/fetch_audio": { "post": { "description": "", "operationId": "fetch_audio", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentAudios" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"audio\"" ] } }, "/api/ai_studio/folder": { "delete": { "description": "", "operationId": "delete_folder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequiredId" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"folder\"" ] }, "get": { "description": "", "operationId": "get_folder", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": {} }, { "in": "query", "name": "workspace_id", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"folder\"" ] }, "post": { "description": "", "operationId": "create_folder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateFolder" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"folder\"" ] }, "put": { "description": "", "operationId": "update_folder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateFolder" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Folder" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"folder\"" ] } }, "/api/ai_studio/generated_video_by/:user_id": { "get": { "description": "", "operationId": "get_generated_video_by_user_id", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedVideo" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/generated_video_by_campaign_id": { "get": { "description": "", "operationId": "get_generated_video_by_campaign_id", "parameters": [ { "in": "query", "name": "campaign_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "page", "required": true, "schema": {} }, { "in": "query", "name": "size", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedVideos" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"generated_video\"" ] } }, "/api/ai_studio/generated_video_by_id": { "get": { "description": "", "operationId": "get_generated_video_by_id", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedVideo" } } }, "description": "" } }, "summary": "", "tags": [ "\"generated_video\"" ] } }, "/api/ai_studio/generated_video_by_paid_users": { "get": { "description": "", "operationId": "get_generated_video_by_paid_users", "parameters": [ { "in": "query", "name": "filter", "required": true, "schema": {} }, { "in": "query", "name": "page", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "size", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedVideoForPaidUser" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/generated_video_by_video_instance_id": { "get": { "description": "", "operationId": "get_generated_video_by_video_instance_id", "parameters": [ { "in": "query", "name": "page", "required": true, "schema": {} }, { "in": "query", "name": "size", "required": true, "schema": {} }, { "in": "query", "name": "video_instance_id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedVideos" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"generated_video\"" ] } }, "/api/ai_studio/get_actors_by/:user_id": { "get": { "description": "", "operationId": "get_actors_by_user_id", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Actor" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/get_generated_video": { "get": { "description": "", "operationId": "get_generated_video", "parameters": [ { "in": "query", "name": "filter", "required": true, "schema": {} }, { "in": "query", "name": "page", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "size", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedVideos" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"generated_video\"" ] } }, "/api/ai_studio/get_reviews/:user_id": { "get": { "description": "", "operationId": "get_reviews", "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/median_by_weekly": { "get": { "description": "", "operationId": "get_weekly_median", "parameters": [ { "in": "query", "name": "from", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "to", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MonthlyMedian" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/onboarding": { "post": { "description": "", "operationId": "process_onboarding", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/onboarding/webhook": { "post": { "description": "", "operationId": "onboarding_webhook", "parameters": [ { "in": "query", "name": "campaign_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "email", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "name", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPipelineWebhook" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/pipeline": { "post": { "description": "", "operationId": "process_pipeline", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/pipeline/campaign": { "post": { "description": "Recommended endpoint for CRM and GoHighLevel integrations. Send a campaign_id, ordered variables, one names row per recipient, optional dynamic background assets, and an optional callback_url. Authenticate with Basic Auth for integrations or Bearer JWT for first-party clients. The API returns generated video IDs immediately; callback_url receives PipelineCompletionCallback when rendering completes.", "operationId": "campaign_to_pipeline", "requestBody": { "content": { "application/json": { "example": { "assets": [ [ "https://example.com/listing-photo.jpg" ] ], "backgrounds": [ { "config": { "brightness": 1.0, "mode": "none", "position": "bottom-right", "scale": 0.42 }, "end": 5.5, "kind": "link", "name": "listing_photo", "start": 2.0 } ], "callback_url": "https://example.com/bhuman-callback", "campaign_id": "00000000-0000-0000-0000-000000000000", "enable_lipsync": true, "generation_mode": "auto", "names": [ [ "Michael" ] ], "variables": [ "name" ] }, "schema": { "$ref": "#/components/schemas/PInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "code": 200, "result": [ "00000000-0000-0000-0000-000000000000" ] }, "schema": { "$ref": "#/components/schemas/BHumanGenerationAccepted" } } }, "description": "Generation request accepted." }, "400": { "content": { "application/json": { "example": { "code": 400, "result": { "error": "Missing variables parameters." } }, "schema": { "$ref": "#/components/schemas/BHumanApiError" } } }, "description": "Invalid request body, campaign configuration, or variable mapping." }, "401": { "content": { "application/json": { "examples": { "invalidCredentials": { "value": { "code": 401, "result": { "error": "Invalid credentials." } } }, "missingAuthorization": { "value": { "code": 401, "result": { "error": "Missing authorization." } } } }, "schema": { "$ref": "#/components/schemas/BHumanApiError" } } }, "description": "Missing or invalid authorization." } }, "security": [ { "BasicAuth": [] }, { "Bearer": [] } ], "summary": "Generate campaign videos", "tags": [ "pipeline" ] } }, "/api/ai_studio/pipeline/leadr": { "post": { "description": "", "operationId": "leadr_to_pipeline", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TSInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "summary": "", "tags": [ "\"leadr\"" ] } }, "/api/ai_studio/pipeline/pabbly": { "post": { "description": "Simplified object-style payload for webhook builders such as GoHighLevel or Pabbly. variables maps campaign segment names to values. This is the easiest smoke-test endpoint for CRM webhooks. Use /api/ai_studio/pipeline/campaign for the final dynamic-background, concurrency, and retry/fail-safe proof.", "operationId": "pabbly_to_pipeline", "requestBody": { "content": { "application/json": { "example": { "callback_url": "https://example.com/bhuman-callback", "campaign_id": "00000000-0000-0000-0000-000000000000", "variables": { "name": "Michael" } }, "schema": { "$ref": "#/components/schemas/PabblyInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "code": 200, "result": [ "00000000-0000-0000-0000-000000000000" ] }, "schema": { "$ref": "#/components/schemas/BHumanGenerationAccepted" } } }, "description": "Generation request accepted." }, "400": { "content": { "application/json": { "example": { "code": 400, "result": { "error": "Missing variables parameters." } }, "schema": { "$ref": "#/components/schemas/BHumanApiError" } } }, "description": "Invalid request body, campaign configuration, or variable mapping." }, "401": { "content": { "application/json": { "examples": { "invalidCredentials": { "value": { "code": 401, "result": { "error": "Invalid credentials." } } }, "missingAuthorization": { "value": { "code": 401, "result": { "error": "Missing authorization." } } } }, "schema": { "$ref": "#/components/schemas/BHumanApiError" } } }, "description": "Missing or invalid authorization." } }, "security": [ { "BasicAuth": [] }, { "Bearer": [] } ], "summary": "Generate videos from a simple integration payload", "tags": [ "pipeline" ] } }, "/api/ai_studio/pipeline/webhook": { "post": { "description": "Internal endpoint called by the BHuman render pipeline. CRM integrations should not call this endpoint. To receive finished-video metadata, send a callback_url in /api/ai_studio/pipeline/campaign, /zapier, or /pabbly.", "operationId": "pipeline_webhook", "parameters": [ { "in": "query", "name": "callback_url", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "campaign_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "campaign_result_id", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "workspace_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPipelineWebhook" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "summary": "Internal render pipeline callback", "tags": [ "pipeline" ] } }, "/api/ai_studio/pipeline/zapier": { "post": { "description": "Structured automation endpoint using the same request shape as the campaign pipeline. Authenticate with Basic Auth for integrations or Bearer JWT for first-party clients.", "operationId": "zapier_to_pipeline", "requestBody": { "content": { "application/json": { "example": { "callback_url": "https://example.com/bhuman-callback", "campaign_id": "00000000-0000-0000-0000-000000000000", "names": [ [ "Michael" ] ], "variables": [ "name" ] }, "schema": { "$ref": "#/components/schemas/PInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "example": { "code": 200, "result": [ "00000000-0000-0000-0000-000000000000" ] }, "schema": { "$ref": "#/components/schemas/BHumanGenerationAccepted" } } }, "description": "Generation request accepted." }, "400": { "content": { "application/json": { "example": { "code": 400, "result": { "error": "Missing variables parameters." } }, "schema": { "$ref": "#/components/schemas/BHumanApiError" } } }, "description": "Invalid request body, campaign configuration, or variable mapping." }, "401": { "content": { "application/json": { "examples": { "invalidCredentials": { "value": { "code": 401, "result": { "error": "Invalid credentials." } } }, "missingAuthorization": { "value": { "code": 401, "result": { "error": "Missing authorization." } } } }, "schema": { "$ref": "#/components/schemas/BHumanApiError" } } }, "description": "Missing or invalid authorization." } }, "security": [ { "BasicAuth": [] }, { "Bearer": [] } ], "summary": "Generate videos from a structured automation payload", "tags": [ "pipeline" ] } }, "/api/ai_studio/review_campaigns/:target/:id": { "put": { "description": "", "operationId": "review_campaign", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReviewOption" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/script": { "post": { "description": "", "operationId": "create_script", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateScript" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GeneratedScript" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"ai script\"" ] } }, "/api/ai_studio/segment": { "delete": { "description": "", "operationId": "delete_segment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SegmentOptionalId" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"segment\"" ] }, "get": { "description": "", "operationId": "get_segment", "parameters": [ { "in": "query", "name": "all", "required": true, "schema": {} }, { "in": "query", "name": "campaign_id", "required": true, "schema": {} }, { "in": "query", "name": "id", "required": true, "schema": {} }, { "in": "query", "name": "video_instance_id", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"segment\"" ] }, "post": { "description": "", "operationId": "create_segment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSegment" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"segment\"" ] }, "put": { "description": "", "operationId": "update_segment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateSegment" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Segment" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"segment\"" ] } }, "/api/ai_studio/segment/voice_config": { "put": { "description": "Whenever update the voice config, it will delete all cached audios that is connected with this video instance", "operationId": "update_voice_config", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVoiceConfig" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "Update voice config and return status", "tags": [ "\"segment\"" ] } }, "/api/ai_studio/speakeasy_projects": { "get": { "description": "", "operationId": "get_speakeasy_projects", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SpeakeasyProjects" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"speakeasy\"" ] } }, "/api/ai_studio/speakeasy_projects/import": { "post": { "description": "", "operationId": "import_speakeasy_project", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportSpeakeasyProjectRequest" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ImportedSpeakeasyVideoInstance" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"speakeasy\"" ] } }, "/api/ai_studio/sync_actor": { "post": { "description": "", "operationId": "sync_actor", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncActor" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/templates": { "post": { "description": "", "operationId": "sync_folder", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SyncFolder" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"admin\"" ] } }, "/api/ai_studio/try_sample": { "post": { "description": "", "operationId": "process_try_sample", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TSInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/try_sample/webhook": { "post": { "description": "", "operationId": "try_sample_webhook", "parameters": [ { "in": "query", "name": "callback_url", "required": true, "schema": {} }, { "in": "query", "name": "campaign_result_id", "required": true, "schema": {} }, { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "video_instance_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "workspace_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPipelineWebhook" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/video_instance": { "delete": { "description": "", "operationId": "delete_video_instance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequiredId" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"video_instance\"" ] }, "get": { "description": "", "operationId": "get_video_instance", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoInstance" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"video_instance\"" ] }, "post": { "description": "", "operationId": "create_video_instance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateVideoInstance" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoInstance" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"video_instance\"" ] }, "put": { "description": "", "operationId": "update_video_instance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateVideoinstance" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoInstance" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"video_instance\"" ] } }, "/api/ai_studio/video_instances": { "get": { "description": "", "operationId": "get_video_instances", "parameters": [ { "in": "query", "name": "page", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "size", "required": true, "schema": { "type": "integer" } }, { "in": "query", "name": "text_to_video", "required": true, "schema": {} }, { "in": "query", "name": "workspace_id", "required": true, "schema": {} } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VideoInstances" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"video_instance\"" ] } }, "/api/ai_studio/videos_distance": { "post": { "description": "", "operationId": "process_videos_distance", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VDInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/videos_distance/webhook": { "post": { "description": "", "operationId": "videos_distance_webhook", "parameters": [ { "in": "query", "name": "video_instance_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "workspace_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPipelineWebhook" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/videos_preview": { "post": { "description": "", "operationId": "process_videos_preview", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/VRInput" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/videos_preview/webhook": { "post": { "description": "", "operationId": "videos_preview_webhook", "parameters": [ { "in": "query", "name": "callback_url", "required": true, "schema": {} }, { "in": "query", "name": "campaign_result_id", "required": true, "schema": {} }, { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "video_instance_id", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "workspace_id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/NewPipelineWebhook" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "summary": "", "tags": [ "\"pipeline\"" ] } }, "/api/ai_studio/webhook": { "delete": { "description": "", "operationId": "delete_webhook", "parameters": [ { "in": "query", "name": "id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": {} } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"webhook\"" ] }, "get": { "description": "", "operationId": "get_webhook", "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignWebhook" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"webhook\"" ] }, "post": { "description": "", "operationId": "create_webhook", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateWebhook" } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CampaignWebhook" } } }, "description": "" } }, "security": [ { "Bearer": [] } ], "summary": "", "tags": [ "\"webhook\"" ] } } }, "servers": [ { "description": "Production", "url": "https://studio.bhuman.ai" } ], "tags": [ { "description": "Personalized video generation and render pipeline endpoints.", "name": "pipeline" }, { "description": "Simple object-style integration payloads for webhook builders.", "name": "pabbly" }, { "description": "Structured integration payloads for Zapier-style automation.", "name": "zapier" } ] }