π Upscayl - #1 Free and Open Source AI Image Upscaler for Linux, MacOS and Windows.
TypeScript aielectronesrgangigapixelgigapixel-imagesimageimage-upscalingtopazupscaleupscalerimageupscayl
Update API reference documentation to reorder task-related pages
Nayam Amarshe843bdd2edb18
diff --git a/docs/mint.json b/docs/mint.jsonindex 59eb9cc..7716641 100644--- a/docs/mint.json+++ b/docs/mint.json@@ -65,11 +65,11 @@{"group": "API Reference","pages": [- "get-task-status",+ "start-a-new-task","get-upload-url","complete-a-multipart-upload",- "get-upscayl-history",- "start-a-new-task"+ "get-task-status",+ "get-upscayl-history"]}],diff --git a/docs/openapi.yaml b/docs/openapi.yamlindex 9c878e1..89c586f 100644--- a/docs/openapi.yaml+++ b/docs/openapi.yaml@@ -1,4 +1,4 @@-openapi: 3.0.0+openapi: "3.0.2"info:title: Upscayl Cloud APIdescription: |@@ -7,10 +7,10 @@ info:version: 1.0.0contact:name: Upscayl Support- url: https://upscayl.github.io+ url: mailto:[email protected]servers:- url: https://api.upscayl.com/v1- description: Production server+ description: Upscayl Serversecurity:- ApiKeyAuth: []@@ -21,7 +21,7 @@ components:content:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:error: BAD_REQUESTmessage: "Invalid request parameters provided"@@ -31,7 +31,7 @@ components:content:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:error: NOT_FOUNDmessage: "Requested resource could not be found"@@ -40,7 +40,7 @@ components:content:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:error: UNAUTHORIZEDmessage: "Invalid or missing API key"@@ -50,7 +50,7 @@ components:content:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:error: RATE_LIMIT_EXCEEDEDmessage: "Too many requests. Try again in 1 hour"@@ -59,7 +59,7 @@ components:content:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:error: INTERNAL_SERVER_ERRORmessage: "An unexpected error occurred"@@ -85,7 +85,7 @@ components:type: booleandescription: Whether task is in batch modeenhanceFace:- type: boolean+ type: booleandescription: Whether face enhancement is enablederror:type: string@@ -93,10 +93,25 @@ components:files:type: arrayitems:- $ref: '#/components/schemas/ProcessedFile'+ $ref: "#/components/schemas/ProcessedFile"model:type: stringdescription: AI model used for processing+ 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,+ ]progress:type: stringdescription: Processing progress percentage@@ -109,10 +124,10 @@ components:saveImageAs:type: stringenum: [png, jpg, webp]- compression:- type: number- minimum: 0- maximum: 100+ # compression:+ # type: number+ # minimum: 0+ # maximum: 100creditsDeducted:type: booleandeductedCredits:@@ -148,42 +163,57 @@ components:format: int64description: Expiration timestamp (Unix ms)ProcessingTask:- type: object- properties:- batchMode:- type: boolean- description: Whether task was processed in batch mode- enhanceFace:- type: boolean- description: Whether face enhancement was applied- error:- type: string- description: Error message if processing failed- files:- type: array- items:- $ref: '#/components/schemas/ProcessedFile'- model:- type: string- description: AI model used for processing- progress:- type: string- description: Processing progress percentage- scale:- type: string- description: Upscale factor applied- status:- type: string- enum: [pending, processing, completed, failed]- saveImageAs:- type: string- enum: [png, jpg, webp]- compression:- type: number- minimum: 0- maximum: 100- creditsDeducted:- type: boolean+ type: object+ properties:+ batchMode:+ type: boolean+ description: Whether task was processed in batch mode+ enhanceFace:+ type: boolean+ description: Whether face enhancement was applied+ error:+ type: string+ description: Error message if processing failed+ files:+ type: array+ items:+ $ref: "#/components/schemas/ProcessedFile"+ model:+ type: string+ description: AI model used for processing+ 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,+ ]+ progress:+ type: string+ description: Processing progress percentage+ scale:+ type: string+ description: Upscale factor applied+ status:+ type: string+ enum: [pending, processing, completed, failed]+ saveImageAs:+ type: string+ enum: [png, jpg, webp]+ # compression:+ # type: number+ # minimum: 0+ # maximum: 100+ creditsDeducted:+ type: booleanProcessedFile:type: object@@ -238,7 +268,6 @@ tags:- name: Historydescription: Historical data operations-paths:/get-upload-url:post:@@ -344,7 +373,7 @@ paths:content:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"examples:InvalidFileType:value:@@ -359,11 +388,11 @@ paths:error: MISSING_REQUIRED_FIELDSmessage: "Required fields missing: originalFileName""401":- $ref: '#/components/responses/Unauthorized'+ $ref: "#/components/responses/Unauthorized""429":- $ref: '#/components/responses/TooManyRequests'+ $ref: "#/components/responses/TooManyRequests""500":- $ref: '#/components/responses/InternalError'+ $ref: "#/components/responses/InternalError"/get-upscayl-history:post:tags:@@ -441,17 +470,17 @@ paths:data:type: arrayitems:- $ref: '#/components/schemas/ProcessingTask'+ $ref: "#/components/schemas/ProcessingTask""400":- $ref: '#/components/responses/BadRequest'+ $ref: "#/components/responses/BadRequest""401":- $ref: '#/components/responses/Unauthorized'+ $ref: "#/components/responses/Unauthorized""404":- $ref: '#/components/responses/NotFound'+ $ref: "#/components/responses/NotFound""429":- $ref: '#/components/responses/TooManyRequests'+ $ref: "#/components/responses/TooManyRequests""500":- $ref: '#/components/responses/InternalError'+ $ref: "#/components/responses/InternalError"/get-task-status:post:tags:@@ -478,7 +507,7 @@ paths:taskId:type: stringformat: uuid- description: Task ID returned by start-task endpoint. See [Start Image Upscaling Task](#operation/startTask).+ description: Task ID returned by start-task endpoint. See [Start Image Upscaling Task](/start-a-new-task).example: 30a89e69-c702-4247-9905-f0a53dfa45abresponses:"200":@@ -486,32 +515,32 @@ paths:content:application/json:schema:- $ref: '#/components/schemas/TaskStatus'+ $ref: "#/components/schemas/TaskStatus"example:status: successdata:batchMode: falseenhanceFace: true- model: digital-art+ model: digital-art-4xprogress: "75"scale: "4"status: processingfiles: []"400":- $ref: '#/components/responses/BadRequest'+ $ref: "#/components/responses/BadRequest""401":- $ref: '#/components/responses/Unauthorized'+ $ref: "#/components/responses/Unauthorized""404":- $ref: '#/components/responses/NotFound'+ $ref: "#/components/responses/NotFound""429":- $ref: '#/components/responses/TooManyRequests'+ $ref: "#/components/responses/TooManyRequests""500":- $ref: '#/components/responses/InternalError'+ $ref: "#/components/responses/InternalError"/start-task:post:tags:- Tasks- summary: Start Image Upscaling Task+ summary: Start Taskdescription: |Initiates a new image upscaling task with specified parameters.Supports both direct file upload and processing of previously uploaded files.@@ -531,7 +560,7 @@ paths:files:type: arrayitems:- $ref: '#/components/schemas/UploadedFile'+ $ref: "#/components/schemas/UploadedFile"description: Array of previously uploaded files to processfile:type: string@@ -544,19 +573,33 @@ paths:model:type: stringdescription: AI model for upscaling- enum: [digital-art, photo-realistic, anime]+ 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,+ ]example: digital-artscale:type: stringdescription: Upscaling factorenum: ["2", "4", "8"]example: "4"- compression:- type: number- description: Output image compression (0-100)- minimum: 0- maximum: 100- default: 0+ # TODO: compression:+ # type: number+ # description: Output image compression (0-100)+ # minimum: 0+ # maximum: 100+ # default: 0saveImageAs:type: stringenum: [png, jpg, webp]@@ -590,22 +633,22 @@ paths:type: stringexample: Task request sent successfully"400":- $ref: '#/components/responses/BadRequest'+ $ref: "#/components/responses/BadRequest""401":- $ref: '#/components/responses/Unauthorized'+ $ref: "#/components/responses/Unauthorized""402":description: Insufficient creditscontent:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:error: INSUFFICIENT_CREDITSmessage: Not enough credits to process request"429":- $ref: '#/components/responses/TooManyRequests'+ $ref: "#/components/responses/TooManyRequests""500":- $ref: '#/components/responses/InternalError'+ $ref: "#/components/responses/InternalError"/complete-multipart-upload:post:tags:@@ -641,7 +684,7 @@ paths:description: S3 upload IDexample: "abc123def456"key:- type: string+ type: stringdescription: S3 object keyexample: "uploads/image.jpg"parts:@@ -690,18 +733,18 @@ paths:content:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:error: BAD_REQUESTmessage: "Bad Request: Missing required parameters""401":- $ref: '#/components/responses/Unauthorized'+ $ref: "#/components/responses/Unauthorized""500":description: S3 or internal errorcontent:application/json:schema:- $ref: '#/components/schemas/Error'+ $ref: "#/components/schemas/Error"example:- error: INTERNAL_SERVER_ERROR- message: "Error completing multipart upload"\ No newline at end of file+ error: INTERNAL_SERVER_ERROR+ message: "Error completing multipart upload"