{"docsConfig":{"$schema":"https://mintlify.com/docs.json","theme":"mint","name":"Upscayl","colors":{"primary":"#6366f1","light":"#6366f1","dark":"#6366f1"},"favicon":"favicon.svg","logo":{"light":"https://mintcdn.com/upscayl/MCaWPTMBOeP8CJxP/logo/logo.svg?fit=max\u0026auto=format\u0026n=MCaWPTMBOeP8CJxP\u0026q=85\u0026s=f7c0ed6f8e4f4fbe8df9b73a12b4cf58","dark":"https://mintcdn.com/upscayl/MCaWPTMBOeP8CJxP/logo/logo.svg?fit=max\u0026auto=format\u0026n=MCaWPTMBOeP8CJxP\u0026q=85\u0026s=f7c0ed6f8e4f4fbe8df9b73a12b4cf58"},"navbar":{"links":[{"label":"Home","href":"https://upscayl.org/"},{"label":"GitHub","href":"https://github.com/upscayl/upscayl"}],"primary":{"type":"button","label":"Download Upscayl","href":"https://upscayl.org/#download"}},"footer":{"socials":{"website":"https://upscayl.org/","github":"https://github.com/upscayl/","x":"https://twitter.com/upscayl","telegram":"https://t.me/iamnayam"}},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"GitHub","href":"https://github.com/upscayl/","icon":"github"},{"anchor":"Twitter","href":"https://twitter.com/upscayl","icon":"x"},{"anchor":"Telegram","href":"https://t.me/iamnayam","icon":"telegram"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"upscayl","hasAudioNarration":false,"actualSubdomain":"upscayl","customDomains":["docs.upscayl.org"],"gitSource":{"type":"github","owner":"upscayl","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae91ecec3f4a6a9b4d34eb4:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Documentation","count":10},{"language":"default","tag":"Troubleshooting","count":5},{"language":"default","tag":"API Reference","count":4},{"language":"default","tag":"Introduction","count":4},{"language":"default","tag":"Get Started","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":"custom-rbac-roles","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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"start-task","slug":"/start-task","pageMetadata":{"openapi":"post /start-task","title":"Start Upscaling Task","description":"This endpoint processes an upscaling task request, including file uploads.\n","href":"/start-task","hidden":false},"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: \"This endpoint processes an upscaling task request, including file uploads.\"\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":{"config":{},"pageMetadata":{"openapi":"post /start-task","title":"Start Upscaling Task","description":"This endpoint processes an upscaling task request, including file uploads.\n","href":"/start-task","hidden":false}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Start Upscaling Task","description":"This endpoint processes an upscaling task request, including file uploads.\n","operationId":"startTask","requestBody":"f80205ff-87b1-44ac-9fd5-9754e8204231","responses":{"200":"4f6a5db1-80f6-47dc-9322-e794d59f980f","400":"db1e0f75-f6c9-4504-8dbd-57c075e04a3e","402":"73f981e2-a28d-4192-adfb-3ce06fa43122","404":"b58be479-7bcb-4867-a0f0-825089192983","500":"02af863f-a8dc-4b04-973f-414270874fd3"},"security":["e78f29a8-d4ef-47b2-9172-e120586e82a5"],"method":"post","type":"path","servers":["fecf682e-e01e-40d4-acb0-bbf6cdeff027"],"path":"/start-task","baseUrlOptions":["https://api.upscayl.org"],"title":"Start Upscaling Task","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"multipart/form-data":{"schema":{"oneOf":[{"type":"object","required":["enhanceFace","model","scale","saveImageAs","file"],"properties":{"file":{"type":"string","format":"binary","description":"The image file to be processed. Supported formats: JPG, PNG, WEBP.","isRequired":true,"uniqueKey":"oneOf.0.file","typeLabel":"file"},"model":{"type":"string","enum":["upscayl-standard-4x","upscayl-lite-4x","clear-boost-4x","crystal-plus-4x","digital-art-4x","digital-art-plus-4x","natural-max-4x","natural-plus-4x","nature-boost-4x","pure-boost-4x","quick-clear-4x","texture-boost-4x"],"description":"The available AI models for upscaling","isRequired":true,"uniqueKey":"oneOf.0.model","typeLabel":"enum\u003cstring>"},"scale":{"type":"integer","enum":[1,2,3,4,5,6,7,8],"description":"The scaling factor for the task","example":4,"isRequired":true,"uniqueKey":"oneOf.0.scale","typeLabel":"enum\u003cinteger>"},"saveImageAs":{"type":"string","enum":["jpg","png","webp"],"description":"The available image formats for saving","isRequired":true,"uniqueKey":"oneOf.0.saveImageAs","typeLabel":"enum\u003cstring>"},"enhanceFace":{"type":"boolean","description":"Whether to enhance faces in the image.","isRequired":true,"uniqueKey":"oneOf.0.enhanceFace","typeLabel":"boolean"},"files":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the file.","example":"1k2jj2b3c-cnb1234ij.jpg","uniqueKey":"oneOf.0.files.items.[INDEX].fileName","typeLabel":"string"},"fileType":{"type":"string","description":"The MIME type of the file.","example":"image/jpeg","uniqueKey":"oneOf.0.files.items.[INDEX].fileType","typeLabel":"string"},"fileSize":{"type":"integer","description":"The size of the file in bytes.","example":123456,"uniqueKey":"oneOf.0.files.items.[INDEX].fileSize","typeLabel":"integer"},"originalFileName":{"type":"string","description":"The original name of the file.","example":"image.jpg","uniqueKey":"oneOf.0.files.items.[INDEX].originalFileName","typeLabel":"string"},"path":{"type":"string","description":"The path where the file is stored.","example":"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg","uniqueKey":"oneOf.0.files.items.[INDEX].path","typeLabel":"string"},"createdAt":{"type":"integer","description":"Timestamp of file creation.","example":1640995200,"uniqueKey":"oneOf.0.files.items.[INDEX].createdAt","typeLabel":"integer"},"expiresAt":{"type":"integer","description":"Timestamp of file expiration.","example":1640995200,"uniqueKey":"oneOf.0.files.items.[INDEX].expiresAt","typeLabel":"integer"},"dimensions":{"type":"object","properties":{"width":{"type":"integer","description":"The width of the image.","uniqueKey":"oneOf.0.files.items.[INDEX].dimensions.width","typeLabel":"integer"},"height":{"type":"integer","description":"The height of the image.","uniqueKey":"oneOf.0.files.items.[INDEX].dimensions.height","typeLabel":"integer"}},"uniqueKey":"oneOf.0.files.items.[INDEX].dimensions","typeLabel":"object"}},"uniqueKey":"oneOf.0.files.items.[INDEX]","typeLabel":"object"},"description":"The files to be processed. **This is to be only used with 'Get Upload URL' endpoint.**","uniqueKey":"oneOf.0.files","typeLabel":"object[]"},"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"oneOf.0.urls.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"Array of URLs pointing to images to be processed.","uniqueKey":"oneOf.0.urls","typeLabel":"string\u003curi>[]"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["enhanceFace","model","scale","saveImageAs","files"],"properties":{"files":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the file.","example":"1k2jj2b3c-cnb1234ij.jpg","uniqueKey":"oneOf.1.files.items.[INDEX].fileName","typeLabel":"string"},"fileType":{"type":"string","description":"The MIME type of the file.","example":"image/jpeg","uniqueKey":"oneOf.1.files.items.[INDEX].fileType","typeLabel":"string"},"fileSize":{"type":"integer","description":"The size of the file in bytes.","example":123456,"uniqueKey":"oneOf.1.files.items.[INDEX].fileSize","typeLabel":"integer"},"originalFileName":{"type":"string","description":"The original name of the file.","example":"image.jpg","uniqueKey":"oneOf.1.files.items.[INDEX].originalFileName","typeLabel":"string"},"path":{"type":"string","description":"The path where the file is stored.","example":"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg","uniqueKey":"oneOf.1.files.items.[INDEX].path","typeLabel":"string"},"createdAt":{"type":"integer","description":"Timestamp of file creation.","example":1640995200,"uniqueKey":"oneOf.1.files.items.[INDEX].createdAt","typeLabel":"integer"},"expiresAt":{"type":"integer","description":"Timestamp of file expiration.","example":1640995200,"uniqueKey":"oneOf.1.files.items.[INDEX].expiresAt","typeLabel":"integer"},"dimensions":{"type":"object","properties":{"width":{"type":"integer","description":"The width of the image.","uniqueKey":"oneOf.1.files.items.[INDEX].dimensions.width","typeLabel":"integer"},"height":{"type":"integer","description":"The height of the image.","uniqueKey":"oneOf.1.files.items.[INDEX].dimensions.height","typeLabel":"integer"}},"uniqueKey":"oneOf.1.files.items.[INDEX].dimensions","typeLabel":"object"}},"uniqueKey":"oneOf.1.files.items.[INDEX]","typeLabel":"object"},"description":"The files to be processed. **This is to be only used with 'Get Upload URL' endpoint.**","isRequired":true,"uniqueKey":"oneOf.1.files","typeLabel":"object[]"},"model":{"type":"string","enum":["upscayl-standard-4x","upscayl-lite-4x","clear-boost-4x","crystal-plus-4x","digital-art-4x","digital-art-plus-4x","natural-max-4x","natural-plus-4x","nature-boost-4x","pure-boost-4x","quick-clear-4x","texture-boost-4x"],"description":"The available AI models for upscaling","isRequired":true,"uniqueKey":"oneOf.1.model","typeLabel":"enum\u003cstring>"},"scale":{"type":"integer","enum":[1,2,3,4,5,6,7,8],"description":"The scaling factor for the task","example":4,"isRequired":true,"uniqueKey":"oneOf.1.scale","typeLabel":"enum\u003cinteger>"},"saveImageAs":{"type":"string","enum":["jpg","png","webp"],"description":"The available image formats for saving","isRequired":true,"uniqueKey":"oneOf.1.saveImageAs","typeLabel":"enum\u003cstring>"},"enhanceFace":{"type":"boolean","description":"Whether to enhance faces in the image.","isRequired":true,"uniqueKey":"oneOf.1.enhanceFace","typeLabel":"boolean"},"file":{"type":"string","format":"binary","description":"The image file to be processed. Supported formats: JPG, PNG, WEBP.","uniqueKey":"oneOf.1.file","typeLabel":"file"},"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"oneOf.1.urls.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"Array of URLs pointing to images to be processed.","uniqueKey":"oneOf.1.urls","typeLabel":"string\u003curi>[]"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["enhanceFace","model","scale","saveImageAs","urls"],"properties":{"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"oneOf.2.urls.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"Array of URLs pointing to images to be processed.","isRequired":true,"uniqueKey":"oneOf.2.urls","typeLabel":"string\u003curi>[]"},"model":{"type":"string","enum":["upscayl-standard-4x","upscayl-lite-4x","clear-boost-4x","crystal-plus-4x","digital-art-4x","digital-art-plus-4x","natural-max-4x","natural-plus-4x","nature-boost-4x","pure-boost-4x","quick-clear-4x","texture-boost-4x"],"description":"The available AI models for upscaling","isRequired":true,"uniqueKey":"oneOf.2.model","typeLabel":"enum\u003cstring>"},"scale":{"type":"integer","enum":[1,2,3,4,5,6,7,8],"description":"The scaling factor for the task","example":4,"isRequired":true,"uniqueKey":"oneOf.2.scale","typeLabel":"enum\u003cinteger>"},"saveImageAs":{"type":"string","enum":["jpg","png","webp"],"description":"The available image formats for saving","isRequired":true,"uniqueKey":"oneOf.2.saveImageAs","typeLabel":"enum\u003cstring>"},"enhanceFace":{"type":"boolean","description":"Whether to enhance faces in the image.","isRequired":true,"uniqueKey":"oneOf.2.enhanceFace","typeLabel":"boolean"},"file":{"type":"string","format":"binary","description":"The image file to be processed. Supported formats: JPG, PNG, WEBP.","uniqueKey":"oneOf.2.file","typeLabel":"file"},"files":{"type":"array","items":{"type":"object","properties":{"fileName":{"type":"string","description":"The name of the file.","example":"1k2jj2b3c-cnb1234ij.jpg","uniqueKey":"oneOf.2.files.items.[INDEX].fileName","typeLabel":"string"},"fileType":{"type":"string","description":"The MIME type of the file.","example":"image/jpeg","uniqueKey":"oneOf.2.files.items.[INDEX].fileType","typeLabel":"string"},"fileSize":{"type":"integer","description":"The size of the file in bytes.","example":123456,"uniqueKey":"oneOf.2.files.items.[INDEX].fileSize","typeLabel":"integer"},"originalFileName":{"type":"string","description":"The original name of the file.","example":"image.jpg","uniqueKey":"oneOf.2.files.items.[INDEX].originalFileName","typeLabel":"string"},"path":{"type":"string","description":"The path where the file is stored.","example":"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg","uniqueKey":"oneOf.2.files.items.[INDEX].path","typeLabel":"string"},"createdAt":{"type":"integer","description":"Timestamp of file creation.","example":1640995200,"uniqueKey":"oneOf.2.files.items.[INDEX].createdAt","typeLabel":"integer"},"expiresAt":{"type":"integer","description":"Timestamp of file expiration.","example":1640995200,"uniqueKey":"oneOf.2.files.items.[INDEX].expiresAt","typeLabel":"integer"},"dimensions":{"type":"object","properties":{"width":{"type":"integer","description":"The width of the image.","uniqueKey":"oneOf.2.files.items.[INDEX].dimensions.width","typeLabel":"integer"},"height":{"type":"integer","description":"The height of the image.","uniqueKey":"oneOf.2.files.items.[INDEX].dimensions.height","typeLabel":"integer"}},"uniqueKey":"oneOf.2.files.items.[INDEX].dimensions","typeLabel":"object"}},"uniqueKey":"oneOf.2.files.items.[INDEX]","typeLabel":"object"},"description":"The files to be processed. **This is to be only used with 'Get Upload URL' endpoint.**","uniqueKey":"oneOf.2.files","typeLabel":"object[]"}},"uniqueKey":"oneOf.2","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"file":"\u003cstring>","scale":4,"enhanceFace":true,"files":[{"fileName":"1k2jj2b3c-cnb1234ij.jpg","fileType":"image/jpeg","fileSize":123456,"originalFileName":"image.jpg","path":"users/1412v4124v/1k2jj2b3c-cnb1234ij.jpg","createdAt":1640995200,"expiresAt":1640995200,"dimensions":{"width":123,"height":123}}],"urls":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"4f6a5db1-80f6-47dc-9322-e794d59f980f":{"description":"Task request sent successfully","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string","example":"success","uniqueKey":"status","typeLabel":"string"},"data":{"type":"object","properties":{"message":{"type":"string","description":"The message returned.","example":"Task request sent successfully","uniqueKey":"data.message","typeLabel":"string"},"taskId":{"type":"string","description":"The ID of the task that you can use to check the status.","example":"123e4567-e89b-12d3-a456-426614174000","uniqueKey":"data.taskId","typeLabel":"string"},"creditsToDeduct":{"type":"integer","description":"The number of credits to deduct for the task.","example":10,"uniqueKey":"data.creditsToDeduct","typeLabel":"integer"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","data":{"message":"Task request sent successfully","taskId":"123e4567-e89b-12d3-a456-426614174000","creditsToDeduct":10}}}},"exampleType":"generated"}},"headers":{"x-task-cost":{"schema":{"type":"integer"},"description":"The number of credits deducted for the task."}},"exampleType":"generated"},"db1e0f75-f6c9-4504-8dbd-57c075e04a3e":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"string","example":"Bad Request: Missing User","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Bad Request: Missing User"}},"exampleType":"generated"}},"exampleType":"generated"},"73f981e2-a28d-4192-adfb-3ce06fa43122":{"description":"Payment Required","content":{"application/json":{"schema":{"type":"string","example":"Insufficient credits","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"Insufficient credits"}},"exampleType":"generated"}},"exampleType":"generated"},"b58be479-7bcb-4867-a0f0-825089192983":{"description":"Not Found","content":{"application/json":{"schema":{"type":"object","example":"User not found","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":"User not found"}},"exampleType":"generated"}},"exampleType":"generated"},"02af863f-a8dc-4b04-973f-414270874fd3":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","example":"Error processing request","uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":"Error processing request"}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e78f29a8-d4ef-47b2-9172-e120586e82a5":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key required to access the API. You can obtain an API key at [https://upscayl.org/account/api-keys](https://upscayl.org/account/api-keys)\n","scopes":[]}}},"servers":{"fecf682e-e01e-40d4-acb0-bbf6cdeff027":{"url":"https://api.upscayl.org","description":"Upscayl Server"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key required to access the API. You can obtain an API key at [https://upscayl.org/account/api-keys](https://upscayl.org/account/api-keys)\n","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"API key required to access the API. You can obtain an API key at [https://upscayl.org/account/api-keys](https://upscayl.org/account/api-keys)\n","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"X-API-Key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"upscayl","siteName":"Upscayl","title":"Start Upscaling Task - Upscayl","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-01-07T00:50:16.407Z","originalFileLocation":"start-task.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=\"This endpoint processes an upscaling task request, including file uploads.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Upscayl\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/upscayl/7SNhlNuYdiYhIqTt/_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/upscayl/7SNhlNuYdiYhIqTt/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/upscayl/7SNhlNuYdiYhIqTt/_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/upscayl/7SNhlNuYdiYhIqTt/_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/upscayl/7SNhlNuYdiYhIqTt/_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/upscayl/7SNhlNuYdiYhIqTt/_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/upscayl/7SNhlNuYdiYhIqTt/_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/upscayl/7SNhlNuYdiYhIqTt/_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/upscayl/7SNhlNuYdiYhIqTt/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start Upscaling Task - Upscayl\">\u003cmeta data-mint-head property=\"og:description\" content=\"This endpoint processes an upscaling task request, including file uploads.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Upscayl\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.upscayl.org/start-task\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://upscayl.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Start+Upscaling+Task\u0026amp;description=This+endpoint+processes+an+upscaling+task+request%2C+including+file+uploads.%0A\u0026amp;theme=fc10694da120fe7dbd596ac2\u0026amp;signature=51f7c1c9750dbcfef5eb820bba82d33849ef150bfa34a2b2c05e25fb5b19306a\">\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=\"Start Upscaling Task - Upscayl\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"This endpoint processes an upscaling task request, including file uploads.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://upscayl.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Start+Upscaling+Task\u0026amp;description=This+endpoint+processes+an+upscaling+task+request%2C+including+file+uploads.%0A\u0026amp;theme=fc10694da120fe7dbd596ac2\u0026amp;signature=51f7c1c9750dbcfef5eb820bba82d33849ef150bfa34a2b2c05e25fb5b19306a\">\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/upscayl/7SNhlNuYdiYhIqTt/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Upscayl\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#6366f1\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.upscayl.org/start-task\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/start-task.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.upscayl.org/#organization\",\"name\":\"Upscayl\",\"url\":\"https://docs.upscayl.org\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/upscayl/MCaWPTMBOeP8CJxP/logo/logo.svg?fit=max\u0026auto=format\u0026n=MCaWPTMBOeP8CJxP\u0026q=85\u0026s=f7c0ed6f8e4f4fbe8df9b73a12b4cf58\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.upscayl.org#website\",\"name\":\"Upscayl\",\"url\":\"https://docs.upscayl.org\",\"publisher\":{\"@id\":\"https://docs.upscayl.org/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.upscayl.org/start-task#webpage\",\"url\":\"https://docs.upscayl.org/start-task\",\"name\":\"Start Upscaling Task\",\"description\":\"This endpoint processes an upscaling task request, including file uploads.\",\"dateModified\":\"2026-01-07T00:50:16.407Z\",\"isPartOf\":{\"@id\":\"https://docs.upscayl.org#website\"},\"breadcrumb\":{\"@id\":\"https://docs.upscayl.org/start-task#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.upscayl.org/start-task#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Upscayl\",\"item\":\"https://docs.upscayl.org\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Start Upscaling Task\",\"item\":\"https://docs.upscayl.org/start-task\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.upscayl.org/start-task#apireference\",\"headline\":\"Start Upscaling Task\",\"name\":\"Start Upscaling Task\",\"description\":\"This endpoint processes an upscaling task request, including file uploads.\",\"url\":\"https://docs.upscayl.org/start-task\",\"mainEntityOfPage\":{\"@id\":\"https://docs.upscayl.org/start-task#webpage\"},\"dateModified\":\"2026-01-07T00:50:16.407Z\",\"publisher\":{\"@id\":\"https://docs.upscayl.org/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.upscayl.org#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Upscayl\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Upscayl\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/start-task.md","siteName":"Upscayl","nav":{"global":{"anchors":[{"anchor":"GitHub","href":"https://github.com/upscayl/","icon":"github"},{"anchor":"Twitter","href":"https://twitter.com/upscayl","icon":"x"},{"anchor":"Telegram","href":"https://t.me/iamnayam","icon":"telegram"}]},"anchors":[{"anchor":"Documentation","icon":"book-open","groups":[{"group":"Get Started","pages":[{"title":"Introduction","href":"/introduction"}]},{"group":"Troubleshooting","pages":[{"group":"Introduction","pages":[{"title":"General Fixes","href":"/troubleshooting/general-fixes"},{"title":"Linux Troubleshooting","href":"/troubleshooting/linux"},{"title":"MacOS Troubleshooting","href":"/troubleshooting/mac"},{"title":"Windows Troubleshooting","href":"/troubleshooting/windows"}]},{"title":"Logs","description":"How to view and share logs in Upscayl","href":"/troubleshooting/logs"}]},{"group":"API Reference","pages":[{"openapi":"post /start-task","title":"Start Upscaling Task","href":"/start-task"},{"openapi":"post /get-task-status","title":"Get Task Status","description":"This endpoint retrieves the status of a task, including whether it has been processed, credits deducted, and file download links.\nIt also handles credit deduction if the task is processed and credits have not been deducted yet.\n","href":"/get-task-status"},{"openapi":"post /get-upload-url","title":"Get Multipart Upload URLs","href":"/get-upload-url"},{"openapi":"post /complete-multipart-upload","title":"Complete Multipart Upload","href":"/complete-a-multipart-upload"}]}]}]},"basePath":"","title":"Start Upscaling Task - Upscayl","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}