AILabTools API - HD color migration - API:V1.0.0
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. |
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 | Defaults | 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
Parameters
Field | Type | Scope | Description |
---|---|---|---|
error_code | integer | Status Code. | |
error_code_str | string | Error Code. | |
error_msg | string | Error Message. | |
request_id | string | Request ID. Please use this field when calling the Querying asynchronous task results API. | |
log_id | string | Log ID. | |
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 asynchronous 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": "",
"request_id": "",
"log_id": "",
"data": {
"status": "QUEUING",
"image_list": [
"https://www.ailabtools.com/logo.webp"
]
}
}