Skip to main content
POST
/
api
/
image
/
effects
/
image-color-migration
Color Migration
curl --request POST \
  --url https://www.ailabapi.com/api/image/effects/image-color-migration \
  --header 'Content-Type: multipart/form-data' \
  --header 'ailabapi-api-key: <api-key>' \
  --form image='@example-file' \
  --form 'mode=<string>' \
  --form 'color_count=<string>' \
  --form 'color_template=<string>' \
  --form ref='@example-file'
{
  "request_id": "",
  "log_id": "",
  "error_code": 0,
  "error_code_str": "",
  "error_msg": "",
  "error_detail": {
    "status_code": 200,
    "code": "",
    "code_message": "",
    "message": ""
  },
  "data": {
    "image_list": [
      "https://www.ailabtools.com/logo.png"
    ]
  }
}

​
Request

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

​
Image requirements

  • Image format: JPEG JPG PNG BMP
  • Image size: No more than 3 MB.
  • Image resolution: Larger than 64x64px, smaller than 1200x1200px.
  • The images must all be RGB 3-channel or RGBA 4-channel.

​
Headers

FieldRequiredTypeDescription
ailabapi-api-keyYESstringApplication API KEY. Get API KEY

​
Body

​
Fixed Fields

FieldRequiredTypeScopeDescription
imageYESfile
modeYESstringAUTO, TEMPLATE, REF_PICColor extension mode. AUTO`: Automatic color extension.` TEMPLATE: Color palette extension. “REF_PIC: Reference picture extension color.

​
mode === AUTO

FieldRequiredTypeScopeDefaultDescription
color_countNOinteger1, 2, 3, 4, 5, 6, 7, 81Expand the number of color families.

​
mode === TEMPLATE

FieldRequiredTypeExampleDescription
color_templateYESstring056A6B,0A0B0CColor palette topology, Top master color list, color value definition ARGB. e.g. 0A0B0C, array size [1, 7].

​
mode === REF_PIC

FieldRequiredTypeDescription
refYESfileReference image.

​
Response

Response Field Handling Flow
  1. Handle Public Response Fields Parse and validate the Public Response Fields, checking the status code or response message to ensure the request is successful and error-free.
  2. Handle Business Response Fields If the Public Response Fields are valid and error-free, proceed with processing the business logic in the Business Response Fields.

​
Public Response Fields

Viewing Public Response Fields and Error Codes

​
Business Response Fields

FieldTypeDescription
dataobjectThe content of the result data returned.
+image_listarray of stringThe URL address of the image after the coloring is completed, and the image format is PNG.
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.

​
Response Example

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

​
Sample Code

👉 Online Experience 👈If you’d like to see the actual effects, please visit the experience page for a trial.

Authorizations

​
ailabapi-api-key
string
header
required

API Key for authentication

Body

multipart/form-data
​
image
file
​
mode
string

Color extension mode.

  • AUTO: Automatic color extension.
  • TEMPLATE: Color palette extension.
  • REF_PIC: Reference picture extension color.

    • ​
    color_count
    string

    Expand the number of color families.

    ​
    color_template
    string

    Color palette topology, Top master color list, color value definition ARGB. e.g. 0A0B0C, array size [1, 7].

    ​
    ref
    file

    Reference image.

    Response

    200 - application/json

    Success

    The response is of type object.