This is a legacy endpoint for existing integrations. New integrations should use the public v1 API.Upload each source photo once and keep the returned id. It is ready to use in your creation request; there is no generation to wait for at this step.General uploads allow up to 15 MiB. A video-last-frame upload allows up to 10 MiB and must meet the video frame requirements.
Related versions. May be omitted or empty. Never infer a new version is completed from the parent status.
Show child attributes
{"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.4044","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},{"name":"sso-setup-deadline-banner","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/legacy/images/upload","slug":"/api-reference/legacy/images/upload","pageMetadata":{"title":"Upload an image","description":"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.","openapi":"api-reference/legacy.openapi.json POST /images","href":"/api-reference/legacy/images/upload"},"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: \"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.\"\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:[`This is a legacy endpoint for existing integrations. New integrations should use the `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`public v1 API`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`Upload each source photo once and keep the returned `,_jsx(_components.code,{children:`id`}),`. It is ready to use in your `,_jsx(_components.a,{href:`/api-reference/introduction`,children:`creation request`}),`; there is no generation to wait for at this step.`]}),`\n`,_jsxs(_components.p,{children:[`General uploads allow up to 15 MiB. A `,_jsx(_components.code,{children:`video-last-frame`}),` upload allows up to 10 MiB and must meet the `,_jsx(_components.a,{href:`/api-reference/models#video-inputs`,children:`video frame requirements`}),`.`]})]})}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":"Upload an image","description":"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.","openapi":"api-reference/legacy.openapi.json POST /images","href":"/api-reference/legacy/images/upload"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"uploadImage","summary":"Upload an image","description":"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.","tags":["Images"],"responses":{"200":"2d026364-0daf-4b62-bf4a-28b8fe191a0e","default":"21b283f4-9f29-41bf-92e9-3eb3b9a66da3"},"requestBody":"2bba7c06-c7fc-4287-ab06-19fa136a7afa","method":"post","type":"path","servers":["4be2d6ad-3cbb-44b9-9a02-fa217526773d"],"security":["89010c90-210a-4d2c-a152-6173211c4279"],"path":"/images","baseUrlOptions":["https://api.bitstudio.ai"],"title":"Upload an image","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","description":"The image file.","format":"binary","isRequired":true,"uniqueKey":"file","typeLabel":"file"},"type":{"type":"string","description":"Purpose of this upload. For training, use the asset-specific upload endpoint.","example":"virtual-try-on-outfit","isRequired":true,"uniqueKey":"type","typeLabel":"string"}},"required":["file","type"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"file":"\u003cstring>","type":"virtual-try-on-outfit"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"2d026364-0daf-4b62-bf4a-28b8fe191a0e":{"description":"Upload a JPEG, PNG, or WebP file. General uploads allow up to 15 MiB; video-last-frame allows 10 MiB. Use the returned id in later requests.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Resource ID.","format":"uuid","isRequired":true,"uniqueKey":"id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","description":"Job state. Only completed has a finished result.","enum":["pending","generating","completed","failed","policy_blocked","nsfw_filtered"],"isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"path":{"oneOf":[{"type":"string","description":"Result URL. Can be null while the job is pending.","uniqueKey":"path.oneOf.0","typeLabel":"string"},{"type":"null","description":"Result URL. Can be null while the job is pending.","uniqueKey":"path.oneOf.1","typeLabel":"null"}],"uniqueKey":"path","typeLabel":"string | null"},"watermarked_path":{"oneOf":[{"type":"string","description":"","uniqueKey":"watermarked_path.oneOf.0","typeLabel":"string"},{"type":"null","description":"","uniqueKey":"watermarked_path.oneOf.1","typeLabel":"null"}],"uniqueKey":"watermarked_path","typeLabel":"string | null"},"width_px":{"oneOf":[{"type":"integer","description":"","uniqueKey":"width_px.oneOf.0","typeLabel":"integer"},{"type":"null","description":"","uniqueKey":"width_px.oneOf.1","typeLabel":"null"}],"uniqueKey":"width_px","typeLabel":"integer | null"},"height_px":{"oneOf":[{"type":"integer","description":"","uniqueKey":"height_px.oneOf.0","typeLabel":"integer"},{"type":"null","description":"","uniqueKey":"height_px.oneOf.1","typeLabel":"null"}],"uniqueKey":"height_px","typeLabel":"integer | null"},"size_bytes":{"oneOf":[{"type":"integer","description":"","uniqueKey":"size_bytes.oneOf.0","typeLabel":"integer"},{"type":"null","description":"","uniqueKey":"size_bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"size_bytes","typeLabel":"integer | null"},"extension":{"oneOf":[{"type":"string","description":"","uniqueKey":"extension.oneOf.0","typeLabel":"string"},{"type":"null","description":"","uniqueKey":"extension.oneOf.1","typeLabel":"null"}],"uniqueKey":"extension","typeLabel":"string | null"},"is_generated":{"type":"boolean","description":"","uniqueKey":"is_generated","typeLabel":"boolean"},"for_training":{"type":"boolean","description":"Whether the upload is a reusable asset reference.","uniqueKey":"for_training","typeLabel":"boolean"},"task":{"oneOf":[{"type":"string","description":"Operation that created this job.","uniqueKey":"task.oneOf.0","typeLabel":"string"},{"type":"null","description":"Operation that created this job.","uniqueKey":"task.oneOf.1","typeLabel":"null"}],"uniqueKey":"task","typeLabel":"string | null"},"type":{"oneOf":[{"type":"string","description":"","uniqueKey":"type.oneOf.0","typeLabel":"string"},{"type":"null","description":"","uniqueKey":"type.oneOf.1","typeLabel":"null"}],"uniqueKey":"type","typeLabel":"string | null"},"created_timestamp":{"type":"string","description":"","format":"date-time","uniqueKey":"created_timestamp","typeLabel":"string\u003cdate-time>"},"finish_timestamp":{"oneOf":[{"type":"string","description":"","format":"date-time","uniqueKey":"finish_timestamp.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","description":"","format":"date-time","uniqueKey":"finish_timestamp.oneOf.1","typeLabel":"null"}],"uniqueKey":"finish_timestamp","typeLabel":"string\u003cdate-time> | null"},"fail_reason":{"oneOf":[{"type":"string","description":"Human-readable failure detail.","uniqueKey":"fail_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"Human-readable failure detail.","uniqueKey":"fail_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"fail_reason","typeLabel":"string | null"},"failure_code":{"oneOf":[{"type":"string","description":"Machine-readable failure category, when available.","enum":["input_rejected","provider_unavailable","queue_timeout","policy_blocked"],"uniqueKey":"failure_code.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Machine-readable failure category, when available.","enum":["input_rejected","provider_unavailable","queue_timeout","policy_blocked"],"uniqueKey":"failure_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"failure_code","typeLabel":"enum\u003cstring> | null"},"asset_ids":{"oneOf":[{"type":"array","items":{"type":"string","description":"Resource ID.","format":"uuid","uniqueKey":"asset_ids.oneOf.0.items.[INDEX]","typeLabel":"string\u003cuuid>"},"description":"Linked reusable assets.","uniqueKey":"asset_ids.oneOf.0","typeLabel":"string\u003cuuid>[]"},{"type":"null","items":{"type":"string","description":"Resource ID.","format":"uuid"},"description":"Linked reusable assets.","uniqueKey":"asset_ids.oneOf.1","typeLabel":"null"}],"uniqueKey":"asset_ids","typeLabel":"string\u003cuuid>[] | null"},"versions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Version ID. Save this to correlate the operation.","format":"uuid","isRequired":true,"uniqueKey":"versions.items.[INDEX].id","typeLabel":"string\u003cuuid>"},"image_id":{"type":"string","description":"Parent image ID.","format":"uuid","isRequired":true,"uniqueKey":"versions.items.[INDEX].image_id","typeLabel":"string\u003cuuid>"},"source_image_id":{"oneOf":[{"type":"string","description":"Child job ID. Poll GET /images/{id} with this ID to track processing.","format":"uuid","uniqueKey":"versions.items.[INDEX].source_image_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Child job ID. Poll GET /images/{id} with this ID to track processing.","format":"uuid","uniqueKey":"versions.items.[INDEX].source_image_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"versions.items.[INDEX].source_image_id","typeLabel":"string\u003cuuid> | null"},"source_version_id":{"oneOf":[{"type":"string","description":"Resource ID.","format":"uuid","uniqueKey":"versions.items.[INDEX].source_version_id.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","description":"Resource ID.","format":"uuid","uniqueKey":"versions.items.[INDEX].source_version_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"versions.items.[INDEX].source_version_id","typeLabel":"string\u003cuuid> | null"},"version_type":{"type":"string","description":"For example edited, upscaled, or video.","uniqueKey":"versions.items.[INDEX].version_type","typeLabel":"string"},"status":{"type":"string","description":"Job state. Only completed has a finished result.","enum":["pending","generating","completed","failed","policy_blocked","nsfw_filtered"],"uniqueKey":"versions.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"path":{"type":"string","description":"Result URL; may be empty while processing.","uniqueKey":"versions.items.[INDEX].path","typeLabel":"string"},"width_px":{"type":"integer","description":"","uniqueKey":"versions.items.[INDEX].width_px","typeLabel":"integer"},"height_px":{"type":"integer","description":"","uniqueKey":"versions.items.[INDEX].height_px","typeLabel":"integer"},"created_timestamp":{"type":"string","description":"","format":"date-time","uniqueKey":"versions.items.[INDEX].created_timestamp","typeLabel":"string\u003cdate-time>"},"fail_reason":{"oneOf":[{"type":"string","description":"","uniqueKey":"versions.items.[INDEX].fail_reason.oneOf.0","typeLabel":"string"},{"type":"null","description":"","uniqueKey":"versions.items.[INDEX].fail_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"versions.items.[INDEX].fail_reason","typeLabel":"string | null"},"failure_code":{"oneOf":[{"type":"string","description":"","uniqueKey":"versions.items.[INDEX].failure_code.oneOf.0","typeLabel":"string"},{"type":"null","description":"","uniqueKey":"versions.items.[INDEX].failure_code.oneOf.1","typeLabel":"null"}],"uniqueKey":"versions.items.[INDEX].failure_code","typeLabel":"string | null"}},"required":["id","image_id"],"uniqueKey":"versions.items.[INDEX]","typeLabel":"object"},"description":"Related versions. May be omitted or empty. Never infer a new version is completed from the parent status.","uniqueKey":"versions","typeLabel":"object[]"}},"required":["id","status"],"uniqueKey":"","typeLabel":"object"},"example":{"id":"11111111-1111-4111-8111-111111111111","status":"completed","path":"https://media.bitstudio.ai/public/homepage/2026-09/bitstudio-shirt-reference-front-v1-77caf2ea41d661e4.webp","width_px":900,"height_px":1125,"is_generated":false,"created_timestamp":"2026-09-06T12:00:00Z"},"examples":{"Example":{"title":"Example","value":{"id":"11111111-1111-4111-8111-111111111111","status":"completed","path":"https://media.bitstudio.ai/public/homepage/2026-09/bitstudio-shirt-reference-front-v1-77caf2ea41d661e4.webp","width_px":900,"height_px":1125,"is_generated":false,"created_timestamp":"2026-09-06T12:00:00Z"}}},"exampleType":"examples"}},"exampleType":"examples"},"21b283f4-9f29-41bf-92e9-3eb3b9a66da3":{"description":"Request rejected or service error. See the errors and recovery guide.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","description":"Some handlers return a plain error string.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Structured error code, when available.","uniqueKey":"code","typeLabel":"string"},"message":{"type":"string","description":"Structured human-readable error, when available.","uniqueKey":"message","typeLabel":"string"},"cta":{"type":"boolean","description":"Whether the response includes an account action.","uniqueKey":"cta","typeLabel":"boolean"},"next_action":{"type":"string","description":"Suggested action, such as a plan or credit change.","uniqueKey":"next_action","typeLabel":"string"},"current_plan":{"type":"string","description":"","uniqueKey":"current_plan","typeLabel":"string"},"user_message":{"type":"string","description":"User-facing explanation when present.","uniqueKey":"user_message","typeLabel":"string"},"extra_context":{"type":"string","description":"Additional error context when present.","uniqueKey":"extra_context","typeLabel":"string"}},"description":"Error shapes differ by endpoint. Read message or error; preserve the HTTP status and code. Additional context fields may be returned.","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","cta":true,"next_action":"\u003cstring>","current_plan":"\u003cstring>","user_message":"\u003cstring>","extra_context":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"89010c90-210a-4d2c-a152-6173211c4279":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Create an API key in Studio → account menu → API Keys. Keep it on your server.","scopes":[]}}},"servers":{"4be2d6ad-3cbb-44b9-9a02-fa217526773d":{"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/legacy.openapi.json"},"subdomain":"bitstudio-docs","siteName":"bitStudio","title":"Upload an image - bitStudio","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-16T14:02:17.202Z","originalFileLocation":"api-reference/legacy/images/upload.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=\"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.\">\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=\"Upload an image - bitStudio\">\u003cmeta data-mint-head property=\"og:description\" content=\"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"bitStudio\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.bitstudio.ai/api-reference/legacy/images/upload\">\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=Legacy+API\u0026amp;title=Upload+an+image\u0026amp;description=Upload+a+JPEG%2C+PNG%2C+or+WebP+photo+and+use+its+returned+ID+in+a+creation+request.\u0026amp;theme=62d2ca748a838cdda4bf2743\u0026amp;signature=98dd14a19bac6912976a5948ebd8e708a0a4f441f29db3f44a80d85654474d4c\">\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=\"Upload an image - bitStudio\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bitstudio-docs.mintlify.app/_mintlify/api/og/v2?division=Legacy+API\u0026amp;title=Upload+an+image\u0026amp;description=Upload+a+JPEG%2C+PNG%2C+or+WebP+photo+and+use+its+returned+ID+in+a+creation+request.\u0026amp;theme=62d2ca748a838cdda4bf2743\u0026amp;signature=98dd14a19bac6912976a5948ebd8e708a0a4f441f29db3f44a80d85654474d4c\">\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/legacy/images/upload\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/legacy/images/upload.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/legacy/images/upload#webpage\",\"url\":\"https://docs.bitstudio.ai/api-reference/legacy/images/upload\",\"name\":\"Upload an image\",\"description\":\"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.\",\"dateModified\":\"2026-09-16T14:02:17.202Z\",\"isPartOf\":{\"@id\":\"https://docs.bitstudio.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.bitstudio.ai/api-reference/legacy/images/upload#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.bitstudio.ai/api-reference/legacy/images/upload#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"More reference\",\"item\":\"https://docs.bitstudio.ai/api-reference/jobs-and-versions\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Legacy API\",\"item\":\"https://docs.bitstudio.ai/api-reference/jobs-and-versions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Upload an image\",\"item\":\"https://docs.bitstudio.ai/api-reference/legacy/images/upload\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.bitstudio.ai/api-reference/legacy/images/upload#apireference\",\"headline\":\"Upload an image\",\"name\":\"Upload an image\",\"description\":\"Upload a JPEG, PNG, or WebP photo and use its returned ID in a creation request.\",\"url\":\"https://docs.bitstudio.ai/api-reference/legacy/images/upload\",\"mainEntityOfPage\":{\"@id\":\"https://docs.bitstudio.ai/api-reference/legacy/images/upload#webpage\"},\"dateModified\":\"2026-09-16T14:02:17.202Z\",\"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","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","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","description":"Retrieve a saved image or upload, including its media URL and metadata.","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","description":"Browse your saved images and find previous requests.","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":"Upload an image - bitStudio","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}