AILabTools API - HD color migration - API:V1.0.0(DEPRECATED)

---

draft: true

Important Announcement: API Version Update Notice

Dear Developers,

We are thrilled to announce that our API is receiving a major update! The new version will introduce a host of improvements and feature enhancements to enhance your development experience and meet your needs.

However, along with the rollout of the new version, we must also inform you that the old version of the API will no longer receive maintenance and support. This means that we will no longer release new features, fix known issues, or provide technical support for the old version of the API.

We strongly encourage you to upgrade to the latest version of the API as soon as possible to ensure that your applications continue to operate smoothly and to take advantage of the latest features and optimizations.

If you have any questions or need assistance regarding this change, please feel free to contact our support team ([email protected]). We are committed to assisting you and ensuring a smooth transition.

Once again, thank you for your support and trust in our API.

Best Regards,

AILabTools Support Team

Request

• URL: https://www.ailabapi.com/api/image/effects/image-hd-color-migration
• Method: POST
• Content-Type: multipart/form-data

Image requirements

• Image format: PNG JPG JPEG
• Image size: No more than 3 MB.
• Image resolution: Larger than 64x64px, smaller than 10000x10000px.
• The image must be RGB 3-channel.

Header

Field	Required	Type	Description
ailabapi-api-key	YES	string	Application API KEY. Get API KEY

Body

Fixed Fields

Field	Required	Type	Scope	Example	Description
image	YES	file
mode	YES	string	AUTO TEMPLATE REF_PIC		Color extension mode. AUTO: Automatic color extension. TEMPLATE: Color palette extension. REF_PIC: Reference picture extension color.
degree	YES	string	[0, 1]	0.4	Top color degree.

mode === AUTO

Field	Required	Type	Scope	Default	Description
color_count	NO	integer	1 2 3 4 5 6 7 8	1	Expand the number of color families.

mode === TEMPLATE

Field	Required	Type	Example	Description
color_template	YES	string	056A6B,0A0B0C	Color palette topology, Top master color list, color value definition ARGB. e.g. 0A0B0C, array size [1, 7].

mode === REF_PIC

Field	Required	Type	Description
ref	YES	file	Reference image.

Response

Processing Flow

1. Handle Public Parameters:

   First, parse and validate the Public Parameters, checking the status code or response message to ensure the request is successful and no errors are present.

2. Handle Business Parameters:

   If the public parameters are valid and no exceptions are found, proceed to process the business logic in the Business Parameters.

Public Parameters

Viewing Public Parameters and Error Codes

Business Parameters

Field	Type	Scope	Description
data	object		The content of the result data returned.
+status	string	QUEUING PROCESSING PROCESS_SUCCESS PROCESS_FAILED TIMEOUT_FAILED LIMIT_RETRY_FAILED	Asynchronous task status. QUEUING: Task queuing in progress. PROCESSING: Asynchronous processing in progress. PROCESS_SUCCESS: processing success. PROCESS_FAILED: Processing failed. TIMEOUT_FAILED: The task timed out and did not finish processing. LIMIT_RETRY_FAILED: The maximum number of processing failure retries has been exceeded.
+image_list	array of string		The URL address of the image after the coloring is completed, and the image format is PNG. Return when the result of the query asynchronous task is successful.

tip

The URL address is a temporary address, valid for 24 hours, and will not be accessible after it expires. If you need to save the file for a long time or permanently, please visit the URL address within 24 hours and download the file to your own storage space.

tip

This API is asynchronous API, if the processing result image_list is not obtained in synchronous state, please keep request_id and call Querying Async Task Results API to obtain the processing result.

Asynchronous task results are valid for 30 minutes. It is recommended that asynchronous task results be queried every 5 seconds.

Example

{
  "error_code":     0,
  "error_code_str": "",
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "status":     "QUEUING",
    "image_list": [
      "https://www.ailabtools.com/logo.webp"
    ]
  }
}

Code example

• Introduction
• Code example