Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"VideoBGRemover API","description":"Developer-first API for AI-powered video background removal. Remove backgrounds, create transparent videos, and automate video processing workflows.","colors":{"primary":"#00D4FF","light":"#475569","dark":"#1E293B"},"logo":{"light":"https://mintcdn.com/videobgremover/EnD9kVN7arWrKHfj/logo/logo-with-text.webp?fit=max\u0026auto=format\u0026n=EnD9kVN7arWrKHfj\u0026q=85\u0026s=9c63fc9d33fab3d10e7ef61996d52b05","dark":"https://mintcdn.com/videobgremover/EnD9kVN7arWrKHfj/logo/logo-with-text.webp?fit=max\u0026auto=format\u0026n=EnD9kVN7arWrKHfj\u0026q=85\u0026s=9c63fc9d33fab3d10e7ef61996d52b05","href":"https://videobgremover.com"},"favicon":"https://mintcdn.com/videobgremover/EnD9kVN7arWrKHfj/favicon.ico?fit=max\u0026auto=format\u0026n=EnD9kVN7arWrKHfj\u0026q=85\u0026s=5ae7ad2cce4f42b47a79aff298304130","api":{"playground":{},"examples":{"languages":["curl","javascript","python"]}},"appearance":{"default":"dark","strict":true},"background":{"decoration":"gradient","color":{"light":"#0F172A","dark":"#0F172A"}},"navbar":{"links":[{"href":"https://videobgremover.com/create","label":"Remove Video Background"},{"href":"https://videobgremover.com/api-management","label":"API Management"}],"primary":{"type":"button","label":"Get Started","href":"https://videobgremover.com/signin/signup?redirect=/api-management"}},"footer":{"links":[{"header":"Product","items":[{"label":"Remove Video Background","href":"https://videobgremover.com/create"},{"label":"API Management","href":"https://videobgremover.com/api-management"},{"label":"Pricing","href":"https://videobgremover.com/pricing"}]},{"header":"Resources","items":[{"label":"Blog","href":"https://videobgremover.com/blog"},{"label":"Support","href":"https://videobgremover.com/contact"}]},{"header":"Developers","items":[{"label":"Python SDK","href":"https://github.com/videobgremover/videobgremover-python"},{"label":"Node.js SDK","href":"https://github.com/videobgremover/videobgremover-node"}]},{"header":"Company","items":[{"label":"Privacy Policy","href":"https://videobgremover.com/privacy"},{"label":"Terms of Service","href":"https://videobgremover.com/terms"}]}]},"seo":{"metatags":{"og:title":"API \u0026 SDK Documentation for Video Background Removal with AI","og:description":"Developer-first API for AI-powered video background removal. Remove backgrounds, create transparent videos, and automate video processing workflows with our comprehensive API.","og:image":"https://videobgremover.com/opengraph-api-docs.png","og:logo":"https://videobgremover.com/logo_256.webp","og:url":"https://docs.videobgremover.com","og:site_name":"VideoBGRemover API Documentation","og:type":"website","og:locale":"en_US","twitter:card":"summary_large_image","twitter:title":"API \u0026 SDK Documentation for Video Background Removal with AI","twitter:description":"Developer-first API for AI-powered video background removal. Remove backgrounds, create transparent videos, and automate video processing workflows.","twitter:image":"https://videobgremover.com/opengraph-api-docs.png","twitter:site":"@videobgremover","description":"Comprehensive API documentation for VideoBGRemover - AI-powered video background removal service. Remove backgrounds from videos, create transparent videos, and integrate with your applications.","keywords":"video background removal, AI API, transparent video, video processing, background remover, video editing API, remove video background, transparent video API","author":"VideoBGRemover","robots":"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1","viewport":"width=device-width, initial-scale=1.0","format-detection":"telephone=no","theme-color":"#00D4FF","msapplication-TileColor":"#00D4FF","msapplication-TileImage":"/logo_256.webp"},"indexing":"navigable"},"styling":{"eyebrows":"breadcrumbs","codeblocks":"dark","latex":false},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"videobgremover","hasAudioNarration":false,"actualSubdomain":"videobgremover","customDomains":["docs.videobgremover.com"],"gitSource":{"type":"github","owner":"rousselpaul","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6ac3bc4ed35096bbfa949872","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"API Reference","count":15},{"language":"default","tag":"Guides","count":13},{"language":"default","tag":"Video Background Removal","count":6},{"language":"default","tag":"Jobs","count":6},{"language":"default","tag":"Video Composition","count":5},{"language":"default","tag":"SDK Reference","count":4},{"language":"default","tag":"Getting Started","count":3},{"language":"default","tag":"Examples \u0026 Integrations","count":2},{"language":"default","tag":"API","count":1},{"language":"default","tag":"Credits","count":1}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/jobs/start-processing-a-video-job","slug":"/api-reference/jobs/start-processing-a-video-job","pageMetadata":{"title":"Start processing a video job","description":"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/jobs/{id}/start","href":"/api-reference/jobs/start-processing-a-video-job","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"title":"Start processing a video job","description":"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/jobs/{id}/start","href":"/api-reference/jobs/start-processing-a-video-job","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"startJob","summary":"Start processing a video job","x-mint":{"metadata":{"description":"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response."}},"description":"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.","tags":["Jobs"],"parameters":["436ddf6b-9d77-4fa4-ad50-18ca32eb320a"],"requestBody":"05789751-7010-44b0-a85d-bef038b97790","responses":{"200":"3cc5c674-0168-487d-bcec-655a9b37882f","400":"029029fd-4cd4-4d29-8280-d4ffc3d9a7e6","401":"039fa9f7-0e3f-44af-b4ac-5942e71fed0a","402":"cb918505-7ac5-4625-bacd-b8e009296db2","404":"f9544041-e051-4e85-98c8-7d3399ce1672","500":"8244c6b9-8a61-4c29-8741-b17f2a49fd22"},"method":"post","type":"path","servers":["e60ebbda-b107-4e33-b983-e2f39cc45b03"],"security":["2559eb77-ca30-4650-9901-1d40dc851104"],"path":"/v1/jobs/{id}/start","baseUrlOptions":["https://api.videobgremover.com"],"title":"Start processing a video job","codeSamples":[],"requestExampleLanguages":["bash","javascript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"436ddf6b-9d77-4fa4-ad50-18ca32eb320a":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Job ID returned from job creation","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Job ID returned from job creation"}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"format":{"type":"string","enum":["mp4"],"default":"mp4","description":"Output video format","uniqueKey":"format","typeLabel":"enum\u003cstring>"},"model":{"type":"string","enum":["videobgremover-original","videobgremover-light","videobgremover-pro","videobgremover-human"],"default":"videobgremover-original","description":"AI model for background removal:\n- **videobgremover-original**: High-quality background removal. Best for detailed segmentation and complex scenes. Supports text prompts.\n- **videobgremover-light**: Fast and efficient background removal. Optimized for speed while maintaining good quality.\n- **videobgremover-pro**: Advanced background removal for complex objects. Supports text prompts.\n- **videobgremover-human**: Fast matting algorithm optimized for portraits and facing people.\n","uniqueKey":"model","typeLabel":"enum\u003cstring>"},"prompt":{"type":"object","properties":{"mode":{"type":"string","enum":["auto","text"],"default":"auto","description":"Prompting mode:\n- **auto**: Automatic background detection (default, works with all models)\n- **text**: Text-based prompt for specific subjects (videobgremover-original and videobgremover-pro)\n","isRequired":true,"uniqueKey":"prompt.mode","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"Natural language description of the subject to keep in the video (required when mode is \"text\"). Examples: \"person\", \"dog\", \"car with red paint\"","uniqueKey":"prompt.text","typeLabel":"string"}},"required":["mode"],"uniqueKey":"prompt","typeLabel":"object"},"background":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["color","transparent","composition"],"description":"Background type","isRequired":true,"uniqueKey":"background.type","typeLabel":"enum\u003cstring>"},"color":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","description":"Hex color code (required when type is \"color\")","example":"#FF0000","uniqueKey":"background.color","typeLabel":"string"},"transparent_format":{"type":"string","enum":["webm_vp9","mov_prores","png_sequence","pro_bundle","stacked_video","stacked_video_mask_inverted","mask_video","mask_video_inverted","gif","webp","lottie"],"description":"Transparent output format (when type is \"transparent\")","uniqueKey":"background.transparent_format","typeLabel":"enum\u003cstring>"},"transform":{"type":"object","description":"Optional transform applied to all transparent formats (crop, resize, fps).\nUse `max_width` and `fps` to control output size — important for `gif` and `webp`,\nwhere unconstrained 720p/30fps output can exceed 50MB.\n","properties":{"crop":{"type":"object","description":"Crop region in input pixel coordinates (applied before resize)","required":["x","y","width","height"],"properties":{"x":{"type":"integer","minimum":0,"description":"Left offset in pixels","isRequired":true,"uniqueKey":"background.transform.crop.x","typeLabel":"integer"},"y":{"type":"integer","minimum":0,"description":"Top offset in pixels","isRequired":true,"uniqueKey":"background.transform.crop.y","typeLabel":"integer"},"width":{"type":"integer","minimum":1,"description":"Crop width in pixels","isRequired":true,"uniqueKey":"background.transform.crop.width","typeLabel":"integer"},"height":{"type":"integer","minimum":1,"description":"Crop height in pixels","isRequired":true,"uniqueKey":"background.transform.crop.height","typeLabel":"integer"}},"uniqueKey":"background.transform.crop","typeLabel":"object"},"max_width":{"type":"integer","minimum":1,"description":"Maximum output width in pixels. Aspect ratio is preserved — height scales\nautomatically. Has no effect when the input is already narrower than `max_width`.\nPrimary lever for shrinking GIF/WebP output (e.g. 480 typically cuts file size\nby ~3–4x versus 720p).\n","example":480,"uniqueKey":"background.transform.max_width","typeLabel":"integer"},"fps":{"type":"integer","minimum":1,"maximum":60,"description":"Output frame rate. Lower values produce smaller files; for GIF, 12–15 fps is\nusually a good balance. Defaults to the input video's frame rate.\n","example":15,"uniqueKey":"background.transform.fps","typeLabel":"integer"},"reverse":{"type":"boolean","default":false,"description":"Reverse frame order before encoding","uniqueKey":"background.transform.reverse","typeLabel":"boolean"}},"uniqueKey":"background.transform","typeLabel":"object"},"composition":{"oneOf":[{"type":"object","description":"Composition parameters (required when type is \"composition\")","required":["template"],"properties":{"template":{"type":"string","enum":["ai_ugc_ad","centered","picture_in_picture","fullscreen"],"description":"Pre-configured composition template:\n- **ai_ugc_ad**: 9:16 centered layout optimized for social media ads\n- **centered**: Centered foreground with contain sizing\n- **picture_in_picture**: Small foreground in bottom-right corner\n- **fullscreen**: Foreground covers entire canvas\n","example":"ai_ugc_ad","isRequired":true,"uniqueKey":"background.composition.oneOf.0.template","typeLabel":"enum\u003cstring>"},"background_url":{"type":"string","format":"uri","description":"URL to background image or video (required)","example":"https://example.com/background.mp4","uniqueKey":"background.composition.oneOf.0.background_url","typeLabel":"string\u003curi>"},"background_type":{"type":"string","enum":["image","video"],"description":"Type of background (auto-detected from URL if not specified)","uniqueKey":"background.composition.oneOf.0.background_type","typeLabel":"enum\u003cstring>"},"background_audio_enabled":{"type":"boolean","default":false,"description":"Enable background audio (only for video backgrounds)","uniqueKey":"background.composition.oneOf.0.background_audio_enabled","typeLabel":"boolean"},"background_audio_volume":{"type":"number","minimum":0,"maximum":1,"default":1,"description":"Background audio volume (0.0 to 1.0)","uniqueKey":"background.composition.oneOf.0.background_audio_volume","typeLabel":"number"},"export_format":{"type":"string","enum":["h264"],"default":"h264","description":"Export video codec","uniqueKey":"background.composition.oneOf.0.export_format","typeLabel":"enum\u003cstring>"},"export_crf":{"type":"integer","minimum":0,"maximum":51,"default":23,"description":"Export quality (lower = better quality, 0-51)","uniqueKey":"background.composition.oneOf.0.export_crf","typeLabel":"integer"}},"uniqueKey":"background.composition.oneOf.0","typeLabel":"object"},{"type":"object","description":"Composition parameters (required when type is \"composition\")","required":["background_url","background_type"],"properties":{"background_url":{"type":"string","format":"uri","description":"URL to background image or video","example":"https://example.com/background.mp4","isRequired":true,"uniqueKey":"background.composition.oneOf.1.background_url","typeLabel":"string\u003curi>"},"background_type":{"type":"string","enum":["color","image","video"],"description":"Type of background","isRequired":true,"uniqueKey":"background.composition.oneOf.1.background_type","typeLabel":"enum\u003cstring>"},"background_color":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","description":"Hex color (when background_type is \"color\")","uniqueKey":"background.composition.oneOf.1.background_color","typeLabel":"string"},"background_audio_enabled":{"type":"boolean","default":false,"description":"Enable background audio (video backgrounds only)","uniqueKey":"background.composition.oneOf.1.background_audio_enabled","typeLabel":"boolean"},"background_audio_volume":{"type":"number","minimum":0,"maximum":1,"default":1,"description":"Background audio volume","uniqueKey":"background.composition.oneOf.1.background_audio_volume","typeLabel":"number"},"position":{"type":"string","enum":["center","top_left","top_center","top_right","center_left","center_right","bottom_left","bottom_center","bottom_right"],"default":"center","description":"Anchor position for foreground placement","uniqueKey":"background.composition.oneOf.1.position","typeLabel":"enum\u003cstring>"},"offset_x":{"type":"integer","default":0,"description":"Horizontal offset in pixels from anchor","uniqueKey":"background.composition.oneOf.1.offset_x","typeLabel":"integer"},"offset_y":{"type":"integer","default":0,"description":"Vertical offset in pixels from anchor","uniqueKey":"background.composition.oneOf.1.offset_y","typeLabel":"integer"},"size_mode":{"type":"string","enum":["contain","cover","canvas_percent","px","scale","fit_width","fit_height"],"default":"contain","description":"Foreground sizing mode:\n- **contain**: Fit within canvas, preserve aspect ratio\n- **cover**: Fill canvas, preserve aspect ratio (may crop)\n- **canvas_percent**: Size as percentage of canvas\n- **px**: Exact pixel dimensions\n- **scale**: Scale relative to original size\n- **fit_width**: Fit to canvas width\n- **fit_height**: Fit to canvas height\n","uniqueKey":"background.composition.oneOf.1.size_mode","typeLabel":"enum\u003cstring>"},"size_percent":{"type":"number","description":"Size percentage (when size_mode is \"canvas_percent\")","uniqueKey":"background.composition.oneOf.1.size_percent","typeLabel":"number"},"size_width":{"type":"number","description":"Width value (depends on size_mode)","uniqueKey":"background.composition.oneOf.1.size_width","typeLabel":"number"},"size_height":{"type":"number","description":"Height value (depends on size_mode)","uniqueKey":"background.composition.oneOf.1.size_height","typeLabel":"number"},"opacity":{"type":"number","minimum":0,"maximum":1,"default":1,"description":"Foreground opacity (0.0 to 1.0)","uniqueKey":"background.composition.oneOf.1.opacity","typeLabel":"number"},"export_format":{"type":"string","enum":["h264"],"default":"h264","description":"Export video codec","uniqueKey":"background.composition.oneOf.1.export_format","typeLabel":"enum\u003cstring>"},"export_crf":{"type":"integer","minimum":0,"maximum":51,"default":23,"description":"Export quality (lower = better, 0-51)","uniqueKey":"background.composition.oneOf.1.export_crf","typeLabel":"integer"}},"uniqueKey":"background.composition.oneOf.1","typeLabel":"object"}],"uniqueKey":"background.composition","typeLabel":"object"}},"uniqueKey":"background","typeLabel":"object"},"webhook_url":{"type":"string","format":"uri","description":"Webhook URL to notify when job completes or fails. **Must use HTTPS in production.**","uniqueKey":"webhook_url","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"default_green":{"title":"default_green","value":{"format":"mp4"}},"color_background":{"title":"color_background","value":{"background":{"type":"color","color":"#FF0000"}}},"transparent_webm":{"title":"transparent_webm","value":{"background":{"type":"transparent","transparent_format":"webm_vp9"}}},"lottie_export":{"title":"lottie_export","value":{"background":{"type":"transparent","transparent_format":"lottie"}}},"gif_export":{"title":"gif_export","value":{"background":{"type":"transparent","transparent_format":"gif"}}},"gif_export_small":{"title":"gif_export_small","value":{"background":{"type":"transparent","transparent_format":"gif","transform":{"max_width":480,"fps":15}}}},"webp_export":{"title":"webp_export","value":{"background":{"type":"transparent","transparent_format":"webp"}}},"pro_bundle":{"title":"pro_bundle","value":{"background":{"type":"transparent","transparent_format":"pro_bundle"}}},"composition_template":{"title":"composition_template","value":{"background":{"type":"composition","composition":{"template":"ai_ugc_ad","background_url":"https://example.com/background.mp4","background_type":"video","background_audio_enabled":true,"background_audio_volume":0.8}}}},"composition_custom":{"title":"composition_custom","value":{"background":{"type":"composition","composition":{"background_url":"https://example.com/background.jpg","background_type":"image","position":"center","size_mode":"canvas_percent","size_percent":50,"opacity":1}}}},"text_prompt_pro":{"title":"text_prompt_pro","value":{"model":"videobgremover-pro","prompt":{"mode":"text","text":"person wearing red jacket"},"background":{"type":"transparent","transparent_format":"webm_vp9"}}},"auto_prompt_explicit":{"title":"auto_prompt_explicit","value":{"model":"videobgremover-original","prompt":{"mode":"auto"},"background":{"type":"transparent","transparent_format":"stacked_video"}}},"auto_prompt_omitted":{"title":"auto_prompt_omitted","value":{"model":"videobgremover-light","background":{"type":"color","color":"#00FF00"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"3cc5c674-0168-487d-bcec-655a9b37882f":{"description":"Processing started successfully","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"Job identifier","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"export_id":{"type":"string","format":"uuid","description":"Export identifier (when background is specified)","uniqueKey":"export_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["processing"],"description":"Processing status","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"string","format":"date-time","description":"Processing start time","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"creditsUsed":{"type":"number","description":"Credits deducted for this job","uniqueKey":"creditsUsed","typeLabel":"number"},"video_length_seconds":{"type":"number","description":"Video duration in seconds","uniqueKey":"video_length_seconds","typeLabel":"number"},"background":{"type":"object","required":["type"],"properties":{"type":{"type":"string","enum":["color","transparent","composition"],"description":"Background type","isRequired":true,"uniqueKey":"background.type","typeLabel":"enum\u003cstring>"},"color":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","description":"Hex color code (required when type is \"color\")","example":"#FF0000","uniqueKey":"background.color","typeLabel":"string"},"transparent_format":{"type":"string","enum":["webm_vp9","mov_prores","png_sequence","pro_bundle","stacked_video","stacked_video_mask_inverted","mask_video","mask_video_inverted","gif","webp","lottie"],"description":"Transparent output format (when type is \"transparent\")","uniqueKey":"background.transparent_format","typeLabel":"enum\u003cstring>"},"transform":{"type":"object","description":"Optional transform applied to all transparent formats (crop, resize, fps).\nUse `max_width` and `fps` to control output size — important for `gif` and `webp`,\nwhere unconstrained 720p/30fps output can exceed 50MB.\n","properties":{"crop":{"type":"object","description":"Crop region in input pixel coordinates (applied before resize)","required":["x","y","width","height"],"properties":{"x":{"type":"integer","minimum":0,"description":"Left offset in pixels","isRequired":true,"uniqueKey":"background.transform.crop.x","typeLabel":"integer"},"y":{"type":"integer","minimum":0,"description":"Top offset in pixels","isRequired":true,"uniqueKey":"background.transform.crop.y","typeLabel":"integer"},"width":{"type":"integer","minimum":1,"description":"Crop width in pixels","isRequired":true,"uniqueKey":"background.transform.crop.width","typeLabel":"integer"},"height":{"type":"integer","minimum":1,"description":"Crop height in pixels","isRequired":true,"uniqueKey":"background.transform.crop.height","typeLabel":"integer"}},"uniqueKey":"background.transform.crop","typeLabel":"object"},"max_width":{"type":"integer","minimum":1,"description":"Maximum output width in pixels. Aspect ratio is preserved — height scales\nautomatically. Has no effect when the input is already narrower than `max_width`.\nPrimary lever for shrinking GIF/WebP output (e.g. 480 typically cuts file size\nby ~3–4x versus 720p).\n","example":480,"uniqueKey":"background.transform.max_width","typeLabel":"integer"},"fps":{"type":"integer","minimum":1,"maximum":60,"description":"Output frame rate. Lower values produce smaller files; for GIF, 12–15 fps is\nusually a good balance. Defaults to the input video's frame rate.\n","example":15,"uniqueKey":"background.transform.fps","typeLabel":"integer"},"reverse":{"type":"boolean","default":false,"description":"Reverse frame order before encoding","uniqueKey":"background.transform.reverse","typeLabel":"boolean"}},"uniqueKey":"background.transform","typeLabel":"object"},"composition":{"oneOf":[{"type":"object","description":"Composition parameters (required when type is \"composition\")","required":["template"],"properties":{"template":{"type":"string","enum":["ai_ugc_ad","centered","picture_in_picture","fullscreen"],"description":"Pre-configured composition template:\n- **ai_ugc_ad**: 9:16 centered layout optimized for social media ads\n- **centered**: Centered foreground with contain sizing\n- **picture_in_picture**: Small foreground in bottom-right corner\n- **fullscreen**: Foreground covers entire canvas\n","example":"ai_ugc_ad","isRequired":true,"uniqueKey":"background.composition.oneOf.0.template","typeLabel":"enum\u003cstring>"},"background_url":{"type":"string","format":"uri","description":"URL to background image or video (required)","example":"https://example.com/background.mp4","uniqueKey":"background.composition.oneOf.0.background_url","typeLabel":"string\u003curi>"},"background_type":{"type":"string","enum":["image","video"],"description":"Type of background (auto-detected from URL if not specified)","uniqueKey":"background.composition.oneOf.0.background_type","typeLabel":"enum\u003cstring>"},"background_audio_enabled":{"type":"boolean","default":false,"description":"Enable background audio (only for video backgrounds)","uniqueKey":"background.composition.oneOf.0.background_audio_enabled","typeLabel":"boolean"},"background_audio_volume":{"type":"number","minimum":0,"maximum":1,"default":1,"description":"Background audio volume (0.0 to 1.0)","uniqueKey":"background.composition.oneOf.0.background_audio_volume","typeLabel":"number"},"export_format":{"type":"string","enum":["h264"],"default":"h264","description":"Export video codec","uniqueKey":"background.composition.oneOf.0.export_format","typeLabel":"enum\u003cstring>"},"export_crf":{"type":"integer","minimum":0,"maximum":51,"default":23,"description":"Export quality (lower = better quality, 0-51)","uniqueKey":"background.composition.oneOf.0.export_crf","typeLabel":"integer"}},"uniqueKey":"background.composition.oneOf.0","typeLabel":"object"},{"type":"object","description":"Composition parameters (required when type is \"composition\")","required":["background_url","background_type"],"properties":{"background_url":{"type":"string","format":"uri","description":"URL to background image or video","example":"https://example.com/background.mp4","isRequired":true,"uniqueKey":"background.composition.oneOf.1.background_url","typeLabel":"string\u003curi>"},"background_type":{"type":"string","enum":["color","image","video"],"description":"Type of background","isRequired":true,"uniqueKey":"background.composition.oneOf.1.background_type","typeLabel":"enum\u003cstring>"},"background_color":{"type":"string","pattern":"^#[0-9A-Fa-f]{6}$","description":"Hex color (when background_type is \"color\")","uniqueKey":"background.composition.oneOf.1.background_color","typeLabel":"string"},"background_audio_enabled":{"type":"boolean","default":false,"description":"Enable background audio (video backgrounds only)","uniqueKey":"background.composition.oneOf.1.background_audio_enabled","typeLabel":"boolean"},"background_audio_volume":{"type":"number","minimum":0,"maximum":1,"default":1,"description":"Background audio volume","uniqueKey":"background.composition.oneOf.1.background_audio_volume","typeLabel":"number"},"position":{"type":"string","enum":["center","top_left","top_center","top_right","center_left","center_right","bottom_left","bottom_center","bottom_right"],"default":"center","description":"Anchor position for foreground placement","uniqueKey":"background.composition.oneOf.1.position","typeLabel":"enum\u003cstring>"},"offset_x":{"type":"integer","default":0,"description":"Horizontal offset in pixels from anchor","uniqueKey":"background.composition.oneOf.1.offset_x","typeLabel":"integer"},"offset_y":{"type":"integer","default":0,"description":"Vertical offset in pixels from anchor","uniqueKey":"background.composition.oneOf.1.offset_y","typeLabel":"integer"},"size_mode":{"type":"string","enum":["contain","cover","canvas_percent","px","scale","fit_width","fit_height"],"default":"contain","description":"Foreground sizing mode:\n- **contain**: Fit within canvas, preserve aspect ratio\n- **cover**: Fill canvas, preserve aspect ratio (may crop)\n- **canvas_percent**: Size as percentage of canvas\n- **px**: Exact pixel dimensions\n- **scale**: Scale relative to original size\n- **fit_width**: Fit to canvas width\n- **fit_height**: Fit to canvas height\n","uniqueKey":"background.composition.oneOf.1.size_mode","typeLabel":"enum\u003cstring>"},"size_percent":{"type":"number","description":"Size percentage (when size_mode is \"canvas_percent\")","uniqueKey":"background.composition.oneOf.1.size_percent","typeLabel":"number"},"size_width":{"type":"number","description":"Width value (depends on size_mode)","uniqueKey":"background.composition.oneOf.1.size_width","typeLabel":"number"},"size_height":{"type":"number","description":"Height value (depends on size_mode)","uniqueKey":"background.composition.oneOf.1.size_height","typeLabel":"number"},"opacity":{"type":"number","minimum":0,"maximum":1,"default":1,"description":"Foreground opacity (0.0 to 1.0)","uniqueKey":"background.composition.oneOf.1.opacity","typeLabel":"number"},"export_format":{"type":"string","enum":["h264"],"default":"h264","description":"Export video codec","uniqueKey":"background.composition.oneOf.1.export_format","typeLabel":"enum\u003cstring>"},"export_crf":{"type":"integer","minimum":0,"maximum":51,"default":23,"description":"Export quality (lower = better, 0-51)","uniqueKey":"background.composition.oneOf.1.export_crf","typeLabel":"integer"}},"uniqueKey":"background.composition.oneOf.1","typeLabel":"object"}],"uniqueKey":"background.composition","typeLabel":"object"}},"uniqueKey":"background","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","export_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"processing","created_at":"2023-11-07T05:31:56Z","creditsUsed":123,"video_length_seconds":123,"background":{"type":"color","color":"#FF0000","transparent_format":"webm_vp9","transform":{"crop":{"x":1,"y":1,"width":2,"height":2},"max_width":480,"fps":15,"reverse":false},"composition":{"template":"ai_ugc_ad","background_url":"https://example.com/background.mp4","background_type":"image","background_audio_enabled":false,"background_audio_volume":1,"export_format":"h264","export_crf":23}}}}},"exampleType":"generated"}},"exampleType":"generated"},"029029fd-4cd4-4d29-8280-d4ffc3d9a7e6":{"description":"Bad request - Invalid parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","description":"Additional error details","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"invalid_background":{"title":"invalid_background","value":{"error":"Invalid background color format. Must be hex color like #FF0000"}},"missing_params":{"title":"missing_params","value":{"error":"Must provide either (filename + content_type) OR video_url"}}},"exampleType":"examples"}},"exampleType":"examples"},"039fa9f7-0e3f-44af-b4ac-5942e71fed0a":{"description":"Unauthorized - Invalid or missing API key","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","description":"Additional error details","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Invalid API key"},"examples":{"Example":{"title":"Example","value":{"error":"Invalid API key"}}},"exampleType":"examples"}},"exampleType":"examples"},"cb918505-7ac5-4625-bacd-b8e009296db2":{"description":"Payment Required - Insufficient credits","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","description":"Additional error details","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Not enough credits available"},"examples":{"Example":{"title":"Example","value":{"error":"Not enough credits available"}}},"exampleType":"examples"}},"exampleType":"examples"},"f9544041-e051-4e85-98c8-7d3399ce1672":{"description":"Resource not found","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","description":"Additional error details","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Job not found or does not belong to user"},"examples":{"Example":{"title":"Example","value":{"error":"Job not found or does not belong to user"}}},"exampleType":"examples"}},"exampleType":"examples"},"8244c6b9-8a61-4c29-8741-b17f2a49fd22":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Error message","uniqueKey":"error","typeLabel":"string"},"details":{"type":"string","description":"Additional error details","uniqueKey":"details","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":"Internal server error"},"examples":{"Example":{"title":"Example","value":{"error":"Internal server error"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2559eb77-ca30-4650-9901-1d40dc851104":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"API key with format `vbr_` followed by 32 characters","scopes":[]}}},"servers":{"e60ebbda-b107-4e33-b983-e2f39cc45b03":{"url":"https://api.videobgremover.com","description":"Production server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-Api-Key","description":"API key with format `vbr_` followed by 32 characters","scopes":[]},"schema":{"title":"X-Api-Key","type":"string","description":"API key with format `vbr_` followed by 32 characters","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-Api-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"videobgremover","siteName":"VideoBGRemover API","title":"API \u0026 SDK Documentation for Video Background Removal with AI","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-05T15:05:46.133Z","originalFileLocation":"api-reference/jobs/start-processing-a-video-job.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"dark\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.\">\u003cmeta data-mint-head name=\"keywords\" content=\"video background removal, AI API, transparent video, video processing, background remover, video editing API, remove video background, transparent video API\">\u003cmeta data-mint-head name=\"application-name\" content=\"VideoBGRemover API\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow, max-image-preview:large, max-snippet:-1, max-video-preview:-1\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"API \u0026amp; SDK Documentation for Video Background Removal with AI\">\u003cmeta data-mint-head property=\"og:description\" content=\"Developer-first API for AI-powered video background removal. Remove backgrounds, create transparent videos, and automate video processing workflows with our comprehensive API.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"VideoBGRemover API Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://videobgremover.com/opengraph-api-docs.png\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"API \u0026amp; SDK Documentation for Video Background Removal with AI\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Developer-first API for AI-powered video background removal. Remove backgrounds, create transparent videos, and automate video processing workflows.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://videobgremover.com/opengraph-api-docs.png\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/videobgremover/G6j3nu7KFU493Txs/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"VideoBGRemover API\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#00D4FF\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"og:logo\" content=\"https://videobgremover.com/logo_256.webp\">\u003cmeta data-mint-head name=\"author\" content=\"VideoBGRemover\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"format-detection\" content=\"telephone=no\">\u003cmeta data-mint-head name=\"theme-color\" content=\"#00D4FF\">\u003cmeta data-mint-head name=\"msapplication-TileImage\" content=\"/logo_256.webp\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/jobs/start-processing-a-video-job.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.videobgremover.com/#organization\",\"name\":\"VideoBGRemover API\",\"url\":\"https://docs.videobgremover.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/videobgremover/EnD9kVN7arWrKHfj/logo/logo-with-text.webp?fit=max\u0026auto=format\u0026n=EnD9kVN7arWrKHfj\u0026q=85\u0026s=9c63fc9d33fab3d10e7ef61996d52b05\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.videobgremover.com#website\",\"name\":\"VideoBGRemover API\",\"url\":\"https://docs.videobgremover.com\",\"publisher\":{\"@id\":\"https://docs.videobgremover.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job#webpage\",\"url\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job\",\"name\":\"Start processing a video job\",\"description\":\"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.\",\"dateModified\":\"2026-10-05T15:05:46.133Z\",\"isPartOf\":{\"@id\":\"https://docs.videobgremover.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.videobgremover.com/api-reference/introduction\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Jobs\",\"item\":\"https://docs.videobgremover.com/api-reference/jobs/create-a-new-video-processing-job\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Start processing a video job\",\"item\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job#apireference\",\"headline\":\"Start processing a video job\",\"name\":\"Start processing a video job\",\"description\":\"Start background removal for an uploaded video with the VideoBGRemover API. Choose processing options and receive the exact credit charge in the response.\",\"url\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job\",\"mainEntityOfPage\":{\"@id\":\"https://docs.videobgremover.com/api-reference/jobs/start-processing-a-video-job#webpage\"},\"image\":\"https://videobgremover.com/opengraph-api-docs.png\",\"dateModified\":\"2026-10-05T15:05:46.133Z\",\"publisher\":{\"@id\":\"https://docs.videobgremover.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.videobgremover.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"VideoBGRemover API\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"VideoBGRemover API","nav":{"global":null,"groups":[{"group":"Getting Started","icon":"rocket","pages":[{"title":"Quick Start Guide | Remove Video Background in 5 Minutes","sidebarTitle":"Quick Start","href":"/quickstart"},{"title":"Installation Guide | Install Video Background Remover SDK","sidebarTitle":"Installation","href":"/installation"},{"title":"API Authentication Guide | Video Background Remover API Key Setup","sidebarTitle":"Authentication","href":"/authentication"}]},{"group":"Guides","icon":"book","pages":[{"group":"Video Background Removal","icon":"scissors","pages":[{"title":"Video Background Removal | Remove Video Background with AI","sidebarTitle":"Overview","href":"/video-background-removal/overview"},{"title":"Background Removal Models","sidebarTitle":"Models","href":"/video-background-removal/models"},{"title":"How to Remove Video Background | Guide","sidebarTitle":"Guide","href":"/video-background-removal/guide"},{"title":"Transparent Video Formats | WebM VP9, MOV ProRes","sidebarTitle":"Output Formats","href":"/video-background-removal/output-formats"},{"title":"Animated sticker exports","href":"/sticker-exports"},{"title":"Troubleshooting","href":"/video-background-removal/troubleshooting"}]},{"group":"Video Composition","icon":"film","pages":[{"title":"Video Composition Guide | Create Professional Video Layouts","sidebarTitle":"Overview","href":"/video-composition/overview"},{"title":"Custom Video Backgrounds for video compositions","sidebarTitle":"Backgrounds","href":"/video-composition/backgrounds"},{"title":"Positioning \u0026 Sizing | Remove Video Background Positioning","sidebarTitle":"Positioning \u0026 Sizing","href":"/video-composition/positioning"},{"title":"Video Timing \u0026 Duration Control | Remove Video Background","sidebarTitle":"Timing \u0026 Duration","href":"/video-composition/timing"},{"title":"Remove Video Background Export Guide","sidebarTitle":"Export Formats","href":"/video-composition/export-formats"}]},{"title":"Video Composition via API","sidebarTitle":"API Composition","href":"/guides/api-composition"},{"title":"Webhooks - Real-Time Job Notifications","sidebarTitle":"Webhooks","href":"/guides/webhooks"}]},{"group":"API Reference","icon":"code","pages":[{"title":"API Reference | Video Background Remover","sidebarTitle":"Introduction","href":"/api-reference/introduction"},{"title":"API Response Reference - VideoBGRemover API","sidebarTitle":"Responses","href":"/api-reference/responses"},{"group":"API Reference","pages":[{"title":"Export a video or versioned chat sticker","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/jobs/{id}/exports","href":"/api-reference/export-a-video-or-versioned-chat-sticker"},{"title":"Poll export validation and signed downloads","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/exports/{exportId}","href":"/api-reference/poll-export-validation-and-signed-downloads"}]},{"group":"Jobs","pages":[{"title":"Create a new video processing job","description":"Create a VideoBGRemover API job by uploading a video or providing a public video URL. Get a job ID and prepare the video for background removal.","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/jobs","href":"/api-reference/jobs/create-a-new-video-processing-job"},{"title":"Start processing a video job","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/jobs/{id}/start","href":"/api-reference/jobs/start-processing-a-video-job"},{"title":"Check job processing status","description":"Check a video job with the VideoBGRemover API. Track processing progress and retrieve download URLs for the finished video when the job is complete.","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/jobs/{id}/status","href":"/api-reference/jobs/check-job-processing-status"},{"title":"Delete a video job","deprecated":null,"version":null,"openapi":"/openapi.yaml delete /v1/jobs/{id}","href":"/api-reference/jobs/delete-a-video-job"},{"title":"Refine a job's mask with a SAM3 text prompt","deprecated":null,"version":null,"openapi":"/openapi.yaml post /v1/jobs/{id}/refine-mask","href":"/api-reference/jobs/refine-a-jobs-mask-with-a-sam3-text-prompt"},{"title":"Get mask refinement status","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/refinements/{refinementId}","href":"/api-reference/jobs/get-mask-refinement-status"}]},{"group":"Credits","pages":[{"title":"Check credit balance","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/credits","href":"/api-reference/credits/check-credit-balance"}]},{"group":"API","pages":[{"title":"Get OpenAPI specification","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/openapi","href":"/api-reference/api/get-openapi-specification"}]},{"group":"Webhooks","pages":[{"title":"Get webhook delivery history","deprecated":null,"version":null,"openapi":"/openapi.yaml get /v1/webhooks/deliveries","href":"/api-reference/webhooks/get-webhook-delivery-history"}]}]},{"group":"SDK Reference","icon":"terminal","pages":[{"title":"VideoBGRemoverClient - Complete SDK API Reference","sidebarTitle":"Client","href":"/sdk-reference/client"},{"title":"Video \u0026 Foreground Classes - Video Background Removal SDK","sidebarTitle":"Video \u0026 Foreground","href":"/sdk-reference/video"},{"title":"Video Composition System - Complete SDK Reference","sidebarTitle":"Composition","href":"/sdk-reference/composition"},{"title":"EncoderProfile | Remove Video Background Export Formats","sidebarTitle":"Encoders","href":"/sdk-reference/encoders"}]},{"group":"Examples \u0026 Integrations","icon":"lightbulb","pages":[{"title":"Video Background Removal Examples","sidebarTitle":"Examples","href":"/examples"},{"title":"n8n Integration","href":"/integrations/n8n"}]}]},"basePath":"","title":"API \u0026 SDK Documentation for Video Background Removal with AI","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CBsVopKK.js","utils-DZAk68jJ.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-D32AYZrP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-D_A5_cny.js","snippetPresets-xNRfS9th.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BIB25-tq.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CydJ4w4j.js","shallow-CYPBeQSG.js","getApiPlaygroundDisplay-A5xJVBOu.js","CodeSnippet-BVRTgi3m.js","CodeSnippets-DjD6BSlt.js","Page-Dr40SSJq.js","getPastedJson-D4V4JyrR.js","icon-uhcnG22T.js","MethodPill-CM-ZQdGH.js","DuplicateIcon-B_WnOiNf.js","createIcon-CJsb8utt.js","DynamicMarkdown-D-2HDKEp.js","SectionHeading-KP5xmMgQ.js","axios-vUo_bRtp.js","Markdown-D_k0dg6k.js","clsx-DK3K4Z1S.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-DE3EVdvd.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-fN9H9n9g.js"]}