Skip to main content

AILabTools API - HD Color Migration - API

draft: true​

Important Announcement: The API Documentation Has Been Fully Updated

This API documentation has been completely restructured with an improved and clearer format. The current page will no longer receive active updates or maintenance. For the most accurate and up-to-date information, please switch to the new documentation.

View New Docs

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.

Headers​

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

Body​

Fixed Fields​

FieldRequiredTypeScopeDefaultExampleDescription
task_typeYESstring
  • async
    		• asyncTask Type.
  • async: Asynchronous tasks.
    • imageYESfile
    modeYESstring
  • AUTO
  • TEMPLATE
  • REF_PIC
    		• Color extension mode.
  • AUTO: Automatic color extension.
  • TEMPLATE: Color palette extension.
  • REF_PIC: Reference picture extension color.
    • degreeYESstring[0, 1]0.4Top color degree.

    mode === AUTO​

    FieldRequiredTypeScopeDefaultDescription
    color_countNOinteger
  • 1
  • 2
  • 3
  • 4
  • 5
  • 6
  • 7
  • 8
    		• 1Expand 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​

    FieldTypeScopeDescription
    task_typestring
  • async
    		• Task Type.
  • async: Asynchronous tasks.
    • task_idstringAsynchronous task ID.
    Please use this field when calling the Querying Async Task Results API.

    Response Example​

    {
      "request_id":     "",
      "log_id":         "",
      "error_code":     0,
      "error_msg":      "",
      "error_detail":   {
        "status_code":  200,
        "code":         "",
        "code_message": "",
        "message":      ""
      },
      "task_type":      "",
      "task_id":        ""
    }
    tip

    This API is asynchronous, please keep task_id and call Querying Async Task Results to get the final results.

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

    Querying Async Task Results 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​

    FieldTypeScopeDescription
    task_statusinteger
  • 0
  • 1
  • 2
    		• Asynchronous task status.
  • 0: The task is queued.
  • 1: Asynchronous processing.
  • 2: Processing was successful.
    • dataobjectThe content of the result data returned.
    +image_listarray of stringResult URL address.
    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.

    Response Example​

    {
       "error_code":     0,
       "error_msg":      "",
       "error_detail":   {
          "status_code":  200,
          "code":         "",
          "code_message": "",
          "message":      ""
       },
       "task_status":    0,
       "data":           {
          "image_list": []
       }
    }

    Sample Code​

    👉 Online Experience 👈

    If you'd like to see the actual effects, please visit the experience page for a trial.

    Last updated on