Use a completed image as the source. Upload a black-and-white PNG mask with exactly the same dimensions: white marks the region to change and black preserves it. Send its ID in mask_image_id.The defaults are model v1, mode inpaint, and denoise: 1.0. This operation creates one image. A lower denoise value makes a gentler change.A successful request returns HTTP 202 with a jobs array. Save each id, then get the job until it finishes. Read the completed media from result.url and its reusable ID from result.id. Use an Idempotency-Key when submitting work that may be retried.
Use a unique key for each intended creation. Retry the same method, path and JSON with the same key to replay its response for 24 hours after completion. Conflicting requests and unfinished or uncertain outcomes return 409. An uncertain receipt is never automatically rerun.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"bitStudio","description":"Practical guides to fashion photos, virtual try-on, editing, and video, with the bitStudio API reference.","colors":{"primary":"#525252","light":"#D4D4D4","dark":"#737373"},"logo":{"light":"https://mintcdn.com/bitstudio-docs/JUz9tve18opy8JPn/logo/light.svg?fit=max\u0026auto=format\u0026n=JUz9tve18opy8JPn\u0026q=85\u0026s=492890d236f11eeaa9595fffd6717877","dark":"https://mintcdn.com/bitstudio-docs/JUz9tve18opy8JPn/logo/dark.svg?fit=max\u0026auto=format\u0026n=JUz9tve18opy8JPn\u0026q=85\u0026s=68f5ad9c21204ec54f6b21e507f827b1","href":"https://bitstudio.ai"},"favicon":"https://mintcdn.com/bitstudio-docs/JUz9tve18opy8JPn/favicon.png?fit=max\u0026auto=format\u0026n=JUz9tve18opy8JPn\u0026q=85\u0026s=f32b6b7bdf3eaa3065de0affd37fd813","api":{"openapi":"api-reference/openapi.json","playground":{"display":"simple"}},"navbar":{"links":[{"href":"mailto:[email protected]","label":"Support"}],"primary":{"type":"button","label":"Open Studio","href":"https://bitstudio.ai/studio"}},"footer":{"links":[{"header":"bitStudio","items":[{"label":"Studio","href":"https://bitstudio.ai/studio"},{"label":"Pricing","href":"https://bitstudio.ai/pricing"},{"label":"Contact support","href":"mailto:[email protected]"}]},{"header":"More","items":[{"label":"virtual.fit docs","href":"https://docs.virtual.fit"},{"label":"Privacy policy","href":"https://bitstudio.ai/privacy-policy"},{"label":"Terms of service","href":"https://bitstudio.ai/terms-of-service"}]}]},"seo":{"indexing":"navigable"},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bitstudio-docs","hasAudioNarration":false,"actualSubdomain":"bitstudio-docs","customDomains":["docs.bitstudio.ai"],"gitSource":{"type":"github","owner":"bitstudio-ai","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aaaa1562c444bf4729cadec","collectionId":"d91b7af4-5935-4c1b-807d-cd2d934965ac","liveDeploymentHistoryId":"6aaaa1562c444bf4729cadec","schemaVersion":"v3"},"entitlements":{},"buildId":"6aaaa1562c444bf4729cadec","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"API reference","count":49},{"language":"default","tag":"Guides","count":22},{"language":"default","tag":"More reference","count":20},{"language":"default","tag":"Legacy API","count":20},{"language":"default","tag":"Your creative tools","count":7},{"language":"default","tag":"What do you want to make?","count":6},{"language":"default","tag":"Results and integration","count":5},{"language":"default","tag":"Reusable assets","count":5},{"language":"default","tag":"Image tools","count":5},{"language":"default","tag":"Virtual try-on","count":5}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":"#api-playground-2-operation-page:has(#choose-your-inputs) .tabs:has([data-testid=\"tab-Uploaded person + garment images\"])>[data-component-part=tabs-list]{display:grid;grid-template-columns:repeat(2,minmax(0,1fr));grid-template-rows:repeat(3,auto);grid-auto-flow:column;gap:.5rem;overflow:visible;border:0}#api-playground-2-operation-page:has(#choose-your-inputs) .tabs:has([data-testid=\"tab-Uploaded person + garment images\"])>[data-component-part=tabs-list] [data-component-part=tab-button]{height:100%;max-width:none;margin:0;padding:.625rem .75rem;border:1px solid color-mix(in srgb,currentColor 20%,transparent);white-space:normal;line-height:1.4}#api-playground-2-operation-page:has(#choose-your-inputs) .tabs:has([data-testid=\"tab-Uploaded person + garment images\"])>[data-component-part=tabs-list] [data-active=true]{border-color:currentColor;background:color-mix(in srgb,currentColor 7%,transparent)}"}],"page":{"pagePath":"api-reference/operations/inpaint","slug":"/api-reference/operations/inpaint","pageMetadata":{"title":"Inpaint an area","description":"Use a mask to change part of an image.","openapi":"api-reference/openapi.json POST /v1/images/{id}/inpaint","href":"/api-reference/operations/inpaint"},"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: \"Use a mask to change part of an image.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,..._provideComponents(),...props.components};return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Use a completed image as the source. Upload a black-and-white PNG mask with exactly the same dimensions: white marks the region to change and black preserves it. Send its ID in `,_jsx(_components.code,{children:`mask_image_id`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The defaults are model `,_jsx(_components.code,{children:`v1`}),`, mode `,_jsx(_components.code,{children:`inpaint`}),`, and `,_jsx(_components.code,{children:`denoise: 1.0`}),`. This operation creates one image. A lower denoise value makes a gentler change.`]}),`\n`,_jsxs(_components.p,{children:[`A successful request returns HTTP `,_jsx(_components.code,{children:`202`}),` with a `,_jsx(_components.code,{children:`jobs`}),` array. Save each `,_jsx(_components.code,{children:`id`}),`, then `,_jsx(_components.a,{href:`/api-reference/jobs/get`,children:`get the job`}),` until it finishes. Read the completed media from `,_jsx(_components.code,{children:`result.url`}),` and its reusable ID from `,_jsx(_components.code,{children:`result.id`}),`. Use an `,_jsx(_components.a,{href:`/api-reference/errors`,children:`Idempotency-Key`}),` when submitting work that may be retried.`]})]})}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":{"config":{},"pageMetadata":{"title":"Inpaint an area","description":"Use a mask to change part of an image.","openapi":"api-reference/openapi.json POST /v1/images/{id}/inpaint","href":"/api-reference/operations/inpaint"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"inpaint","summary":"Inpaint an area","responses":{"202":"d40eb45c-3ed2-4720-af01-24a4ef47f5bb","default":"02e2b528-8351-41cc-84ae-22afe77753e0"},"parameters":["a4277541-dd74-4f4d-b798-fc61765e5e18","edd25245-3e59-4d24-85b1-f0ae991350d7"],"requestBody":"e82c0cd7-865f-4314-a2c6-be8822cfb8ea","method":"post","type":"path","servers":["9911ffab-5329-4a22-bdef-a277e79db582"],"security":["c32ffac4-cf2a-4769-b630-a7d7681fd69c"],"path":"/v1/images/{id}/inpaint","baseUrlOptions":["https://api.bitstudio.ai"],"title":"Inpaint an area","description":"Use a mask to change part of an image.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a4277541-dd74-4f4d-b798-fc61765e5e18":{"name":"id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"description":"Source resource ID.","uniqueKey":"","typeLabel":"string\u003cuuid>"},"description":"Source resource ID."},"edd25245-3e59-4d24-85b1-f0ae991350d7":{"name":"Idempotency-Key","in":"header","required":false,"schema":{"type":"string","minLength":1,"maxLength":128,"pattern":"^[!-~]+$","isRequired":false,"description":"Use a unique key for each intended creation. Retry the same method, path and JSON with the same key to replay its response for 24 hours after completion. Conflicting requests and unfinished or uncertain outcomes return 409. An uncertain receipt is never automatically rerun.","uniqueKey":"","typeLabel":"string"},"description":"Use a unique key for each intended creation. Retry the same method, path and JSON with the same key to replay its response for 24 hours after completion. Conflicting requests and unfinished or uncertain outcomes return 409. An uncertain receipt is never automatically rerun."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"properties":{"mask_image_id":{"type":"string","description":"Uploaded black-and-white PNG mask: white marks the region to change; black preserves the surrounding area. Must match the selected source dimensions.","format":"uuid","isRequired":true,"uniqueKey":"mask_image_id","typeLabel":"string\u003cuuid>"},"model":{"type":"string","default":"v1","description":"Model for this operation. Account and plan limits apply.","enum":["v1"],"uniqueKey":"model","typeLabel":"enum\u003cstring>"},"resolution":{"type":"string","enum":["standard","high"],"default":"standard","description":"Output quality; dimensions depend on the model and aspect ratio.","uniqueKey":"resolution","typeLabel":"enum\u003cstring>"},"num_images":{"type":"integer","description":"Number of outputs. Defaults to 1. Account limits still apply.","minimum":1,"maximum":1,"example":1,"default":1,"uniqueKey":"num_images","typeLabel":"integer"},"seed":{"type":"integer","description":"Optional seed; it does not guarantee identical results.","uniqueKey":"seed","typeLabel":"integer"},"prompt":{"type":"string","description":"What should appear in the masked area.","uniqueKey":"prompt","typeLabel":"string"},"mode":{"type":"string","enum":["inpaint","extend"],"default":"inpaint","uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"reference_image_id":{"type":"string","description":"Optional reference, mutually exclusive with reference_asset_id.","format":"uuid","uniqueKey":"reference_image_id","typeLabel":"string\u003cuuid>"},"reference_asset_id":{"type":"string","description":"Optional reusable reference, mutually exclusive with reference_image_id.","format":"uuid","uniqueKey":"reference_asset_id","typeLabel":"string\u003cuuid>"},"asset_ids":{"type":"array","items":{"type":"string","uniqueKey":"asset_ids.items.[INDEX]","typeLabel":"string"},"description":"Additional reusable reference asset IDs. Supported types depend on the operation.","uniqueKey":"asset_ids","typeLabel":"string[]"},"denoise":{"type":"number","minimum":0.05,"maximum":1,"description":"Strength of the change.","example":1,"default":1,"uniqueKey":"denoise","typeLabel":"number"},"style":{"type":"string","description":"Optional style directions.","uniqueKey":"style","typeLabel":"string"},"speed":{"type":"string","description":"Optional processing speed; accepted values depend on the operation and model.","uniqueKey":"speed","typeLabel":"string"}},"required":["mask_image_id"],"uniqueKey":"","typeLabel":"object"},"example":{"mask_image_id":"22222222-2222-4222-8222-222222222222","prompt":"White fabric"},"examples":{"Example":{"title":"Example","value":{"mask_image_id":"22222222-2222-4222-8222-222222222222","prompt":"White fabric"}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"d40eb45c-3ed2-4720-af01-24a4ef47f5bb":{"description":"Accepted; poll each job.","content":{"application/json":{"schema":{"type":"object","required":["jobs"],"properties":{"jobs":{"type":"array","minItems":1,"items":{"type":"object","required":["id","status","task","created_at","result","error","credits_used"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"jobs.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["pending","generating","completed","failed","policy_blocked"],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"task":{"oneOf":[{"type":"string","description":"Processing task. This may be more specific than the submitted operation.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].task.oneOf.0","typeLabel":"string"},{"type":"null","description":"Processing task. This may be more specific than the submitted operation.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].task.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].task","typeLabel":"string | null"},"created_at":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"jobs.items.[INDEX].created_at","typeLabel":"string\u003cdate-time>"},"result":{"oneOf":[{"type":"object","required":["image_id","url","width","height","id","type"],"properties":{"image_id":{"type":"string","format":"uuid","description":"Compatibility alias for id. Use id for new integrations.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.image_id","typeLabel":"string\u003cuuid>"},"url":{"type":"string","format":"uri","description":"Completed media URL.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.url","typeLabel":"string\u003curi>"},"width":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.width.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.width.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.width","typeLabel":"integer | null"},"height":{"oneOf":[{"type":"integer","isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.height.oneOf.0","typeLabel":"integer"},{"type":"null","isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.height.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.height","typeLabel":"integer | null"},"id":{"type":"string","format":"uuid","description":"Opaque media ID. Pass an image result ID into the next image operation.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.id","typeLabel":"string\u003cuuid>"},"type":{"type":"string","enum":["image","video"],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0.type","typeLabel":"enum\u003cstring>"}},"isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.0","typeLabel":"object"},{"type":"null","required":["image_id","url","width","height","id","type"],"properties":{"image_id":{"type":"string","format":"uuid","description":"Compatibility alias for id. Use id for new integrations."},"url":{"type":"string","format":"uri","description":"Completed media URL."},"width":{"oneOf":[{"type":"integer"},{"type":"null"}]},"height":{"oneOf":[{"type":"integer"},{"type":"null"}]},"id":{"type":"string","format":"uuid","description":"Opaque media ID. Pass an image result ID into the next image operation."},"type":{"type":"string","enum":["image","video"]}},"isRequired":true,"uniqueKey":"jobs.items.[INDEX].result.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].result","typeLabel":"object | null"},"error":{"oneOf":[{"type":"object","required":["code","message"],"properties":{"code":{"type":"string","description":"Safe failure classification. Handle unknown or new values with a general failure message.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","description":"Safe, readable failure description.","isRequired":true,"uniqueKey":"jobs.items.[INDEX].error.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"jobs.items.[INDEX].error.oneOf.0","typeLabel":"object"},{"type":"null","required":["code","message"],"properties":{"code":{"type":"string","description":"Safe failure classification. Handle unknown or new values with a general failure message."},"message":{"type":"string","description":"Safe, readable failure description."}},"isRequired":true,"uniqueKey":"jobs.items.[INDEX].error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"jobs.items.[INDEX].error","typeLabel":"object | null"},"credits_used":{"type":"number","minimum":0,"description":"Credits currently charged for this output, in display credits: 1 means one Studio credit. Fractional amounts are preserved. A completed refund is reflected as 0 when polling. Creation and idempotency replay responses are snapshots; poll for the latest charge.","example":1.5,"isRequired":true,"uniqueKey":"jobs.items.[INDEX].credits_used","typeLabel":"number"}},"uniqueKey":"jobs.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"jobs","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"example":{"jobs":[{"id":"11111111-1111-4111-8111-111111111111","status":"pending","task":"inpaint","created_at":"2026-09-15T12:00:00Z","result":null,"error":null,"credits_used":1}]},"examples":{"Example":{"title":"Example","value":{"jobs":[{"id":"11111111-1111-4111-8111-111111111111","status":"pending","task":"inpaint","created_at":"2026-09-15T12:00:00Z","result":null,"error":null,"credits_used":1}]}}},"exampleType":"examples"}},"exampleType":"examples"},"02e2b528-8351-41cc-84ae-22afe77753e0":{"description":"Request failed; inspect code and message.","content":{"application/json":{"schema":{"type":"object","required":["code","message","request_id"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"request_id","typeLabel":"string\u003cuuid>"},"error":{"type":"string","description":"Compatibility error description.","uniqueKey":"error","typeLabel":"string"},"cta":{"type":"boolean","description":"Account action is required.","uniqueKey":"cta","typeLabel":"boolean"},"next_action":{"type":"string","uniqueKey":"next_action","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":"\u003cstring>","message":"\u003cstring>","request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","error":"\u003cstring>","cta":true,"next_action":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"c32ffac4-cf2a-4769-b630-a7d7681fd69c":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API key in Studio → account menu → API Keys. Keep it on your server.","scopes":[]}}},"servers":{"9911ffab-5329-4a22-bdef-a277e79db582":{"url":"https://api.bitstudio.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Create an API key in Studio → account menu → API Keys. Keep it on your server.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Create an API key in Studio → account menu → API Keys. Keep it on your server.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"bitstudio-docs","siteName":"bitStudio","title":"Inpaint an area - bitStudio","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T14:02:17.199Z","originalFileLocation":"api-reference/operations/inpaint.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;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=\"system\"}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=\"Use a mask to change part of an image.\">\u003cmeta data-mint-head name=\"application-name\" content=\"bitStudio\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bitstudio-docs/tvjYdQHndO2KwlSn/_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/bitstudio-docs/tvjYdQHndO2KwlSn/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bitstudio-docs/tvjYdQHndO2KwlSn/_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/bitstudio-docs/tvjYdQHndO2KwlSn/_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/bitstudio-docs/tvjYdQHndO2KwlSn/_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/bitstudio-docs/tvjYdQHndO2KwlSn/_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/bitstudio-docs/tvjYdQHndO2KwlSn/_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/bitstudio-docs/tvjYdQHndO2KwlSn/_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/bitstudio-docs/tvjYdQHndO2KwlSn/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Inpaint an area - bitStudio\">\u003cmeta data-mint-head property=\"og:description\" content=\"Use a mask to change part of an image.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"bitStudio\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bitstudio.ai/api-reference/operations/inpaint\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bitstudio-docs.mintlify.app/_mintlify/api/og/v2?division=Image+tools\u0026amp;title=Inpaint+an+area\u0026amp;description=Use+a+mask+to+change+part+of+an+image.\u0026amp;theme=62d2ca748a838cdda4bf2743\u0026amp;signature=18177830a45878d260c043d1d72eacec21a6dd04a6bb9f8fdb6484e9ba7ab13f\">\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=\"Inpaint an area - bitStudio\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Use a mask to change part of an image.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bitstudio-docs.mintlify.app/_mintlify/api/og/v2?division=Image+tools\u0026amp;title=Inpaint+an+area\u0026amp;description=Use+a+mask+to+change+part+of+an+image.\u0026amp;theme=62d2ca748a838cdda4bf2743\u0026amp;signature=18177830a45878d260c043d1d72eacec21a6dd04a6bb9f8fdb6484e9ba7ab13f\">\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/bitstudio-docs/tvjYdQHndO2KwlSn/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"bitStudio\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#525252\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.bitstudio.ai/api-reference/operations/inpaint\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/operations/inpaint.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.bitstudio.ai/#organization\",\"name\":\"bitStudio\",\"url\":\"https://docs.bitstudio.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bitstudio-docs/JUz9tve18opy8JPn/logo/light.svg?fit=max\u0026auto=format\u0026n=JUz9tve18opy8JPn\u0026q=85\u0026s=492890d236f11eeaa9595fffd6717877\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.bitstudio.ai#website\",\"name\":\"bitStudio\",\"url\":\"https://docs.bitstudio.ai\",\"publisher\":{\"@id\":\"https://docs.bitstudio.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint#webpage\",\"url\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint\",\"name\":\"Inpaint an area\",\"description\":\"Use a mask to change part of an image.\",\"dateModified\":\"2026-09-16T14:02:17.199Z\",\"isPartOf\":{\"@id\":\"https://docs.bitstudio.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Image tools\",\"item\":\"https://docs.bitstudio.ai/api-reference/images/upload\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Inpaint an area\",\"item\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint#apireference\",\"headline\":\"Inpaint an area\",\"name\":\"Inpaint an area\",\"description\":\"Use a mask to change part of an image.\",\"url\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bitstudio.ai/api-reference/operations/inpaint#webpage\"},\"dateModified\":\"2026-09-16T14:02:17.199Z\",\"publisher\":{\"@id\":\"https://docs.bitstudio.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.bitstudio.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"bitStudio\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"bitStudio","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":""}]},{"tab":"API reference","groups":[{"group":"Start building","pages":[{"title":"Create images and video","href":"/api-reference/introduction"},{"title":"Generate your first product photo","sidebarTitle":"Quickstart","icon":"bolt","href":"/api-reference/quickstart"},{"title":"Authenticate with a workspace API key","sidebarTitle":"Authentication","icon":"key","href":"/api-reference/authentication"}]},{"group":"Virtual try-on","pages":[{"title":"Virtual try-on","openapi":"api-reference/openapi.json POST /v1/images/virtual-try-on","href":"/api-reference/operations/virtual-try-on"},{"title":"Try on a single item","href":"/api-reference/try-on/single-item"},{"title":"Try on multiple items","href":"/api-reference/try-on/multiple-items"},{"title":"Prepare try-on inputs","href":"/api-reference/try-on/inputs"},{"title":"Choose quality and use the result","href":"/api-reference/try-on/quality"}]},{"group":"Generate","pages":[{"title":"Generate an image","openapi":"api-reference/openapi.json POST /v1/images/generate","href":"/api-reference/operations/generate"},{"title":"Generate from a prompt","href":"/api-reference/generate/from-prompt"},{"title":"Generate with product references","href":"/api-reference/generate/product-photos"},{"title":"Quality, proportions, and outputs","href":"/api-reference/generate/settings"}]},{"group":"Image tools","pages":[{"title":"Upload an image","openapi":"api-reference/openapi.json POST /v1/images","href":"/api-reference/images/upload"},{"title":"Edit an image","description":"Describe the change to make to a completed image.","openapi":"api-reference/openapi.json POST /v1/images/{id}/edit","href":"/api-reference/operations/edit"},{"title":"Inpaint an area","openapi":"api-reference/openapi.json POST /v1/images/{id}/inpaint","href":"/api-reference/operations/inpaint"},{"title":"Upscale an image","description":"Upscale an image to a 4K target with SeedVR.","openapi":"api-reference/openapi.json POST /v1/images/{id}/upscale","href":"/api-reference/operations/upscale"},{"title":"Get an image or video","openapi":"api-reference/openapi.json GET /v1/images/{id}","href":"/api-reference/images/get"}]},{"group":"Video","pages":[{"title":"Animate an image","openapi":"api-reference/openapi.json POST /v1/images/{id}/video","href":"/api-reference/operations/image-to-video"},{"title":"Generate a video","openapi":"api-reference/openapi.json POST /v1/text-to-video","href":"/api-reference/operations/text-to-video"}]},{"group":"Results and integration","pages":[{"title":"Check progress","openapi":"api-reference/openapi.json GET /v1/jobs/{id}","href":"/api-reference/jobs/get"},{"title":"Use and edit results","href":"/api-reference/results"},{"title":"Reuse products and people","href":"/api-reference/assets-workflow"},{"title":"Models and request settings","href":"/api-reference/models"},{"title":"Errors and safe retries","href":"/api-reference/errors"}]},{"group":"Reusable assets","pages":[{"title":"Create an asset","openapi":"api-reference/openapi.json POST /v1/assets","href":"/api-reference/assets/create"},{"title":"Get an asset","openapi":"api-reference/openapi.json GET /v1/assets/{id}","href":"/api-reference/assets/get"},{"title":"Update an asset","openapi":"api-reference/openapi.json PUT /v1/assets/{id}","href":"/api-reference/assets/update"},{"title":"Upload an asset photo","openapi":"api-reference/openapi.json POST /v1/assets/{id}/images","href":"/api-reference/assets/upload-image"},{"title":"Get asset images","openapi":"api-reference/openapi.json GET /v1/assets/{id}/images","href":"/api-reference/assets/images"}]},{"group":"More reference","pages":[{"group":"Legacy API","expanded":false,"pages":[{"title":"Existing integrations","icon":"code-branch","href":"/api-reference/jobs-and-versions"},{"title":"Create a reusable asset","openapi":"api-reference/legacy.openapi.json POST /assets","href":"/api-reference/legacy/assets/create"},{"title":"Get a reusable asset","openapi":"api-reference/legacy.openapi.json GET /assets/{id}","href":"/api-reference/legacy/assets/get"},{"title":"List asset reference images","openapi":"api-reference/legacy.openapi.json GET /assets/{id}/images","href":"/api-reference/legacy/assets/images"},{"title":"Update a reusable asset","openapi":"api-reference/legacy.openapi.json PUT /assets/{id}","href":"/api-reference/legacy/assets/update"},{"title":"Upload an asset reference","openapi":"api-reference/legacy.openapi.json POST /assets/{id}/images","href":"/api-reference/legacy/assets/upload-image"},{"title":"Get a saved image","openapi":"api-reference/legacy.openapi.json GET /images/{id}","href":"/api-reference/legacy/images/get"},{"title":"Upload an image","openapi":"api-reference/legacy.openapi.json POST /images","href":"/api-reference/legacy/images/upload"},{"title":"List images","openapi":"api-reference/legacy.openapi.json GET /images","href":"/api-reference/images/list"},{"title":"Try on an outfit (existing API)","sidebarTitle":"Try on","openapi":"api-reference/legacy.openapi.json POST /images/virtual-try-on","href":"/api-reference/images/virtual-try-on"},{"title":"Generate photos (existing API)","sidebarTitle":"Generate","openapi":"api-reference/legacy.openapi.json POST /images/generate","href":"/api-reference/images/generate"},{"title":"Generate video from text (existing API)","sidebarTitle":"Text to video","openapi":"api-reference/legacy.openapi.json POST /text-to-video","href":"/api-reference/images/text-to-video"},{"title":"Edit a masked region (existing API)","sidebarTitle":"Inpaint","openapi":"api-reference/legacy.openapi.json POST /images/{id}/inpaint","href":"/api-reference/images/inpaint"},{"title":"Get multiple images","openapi":"api-reference/legacy.openapi.json POST /images/batch","href":"/api-reference/images/batch"},{"title":"Edit an image (existing API)","sidebarTitle":"Edit","openapi":"api-reference/legacy.openapi.json POST /images/{id}/edit","href":"/api-reference/images/edit"},{"title":"Upscale an image (existing API)","sidebarTitle":"Upscale","openapi":"api-reference/legacy.openapi.json POST /images/{id}/upscale","href":"/api-reference/images/upscale"},{"title":"Animate an image (existing API)","sidebarTitle":"Image to video","openapi":"api-reference/legacy.openapi.json POST /images/{id}/video","href":"/api-reference/images/video"},{"title":"List reusable assets","openapi":"api-reference/legacy.openapi.json GET /assets","href":"/api-reference/assets/list"},{"title":"Link an upload to an asset","openapi":"api-reference/legacy.openapi.json POST /images/{id}/asset","href":"/api-reference/assets/link-image"},{"title":"Analyze preset references","openapi":"api-reference/legacy.openapi.json POST /assets/preset-analysis","href":"/api-reference/assets/analyze-preset"}]}]}]}]},"basePath":"","title":"Inpaint an area - bitStudio","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}