AILabTools API - Querying Async Task Results - API

Request

• URL: https://www.ailabapi.com/api/image/asyn-task-results
• Method: GET

Header

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

Query

Field	Required	Type	Scope	Description
job_id	YES	string		The request_id returned by the asynchronous API.
type	YES	string	HD_COLOUR_MIGRATION GENERATE_CARTOONIZED_IMAGE	Asynchronous task type. HD_COLOUR_MIGRATION: HD color migration GENERATE_CARTOONIZED_IMAGE: AI Cartoon Generator

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 [type = HD_COLOUR_MIGRATION]

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: The task is queued. PROCESSING: Asynchronous processing. PROCESS_SUCCESS: Processing was successful. PROCESS_FAILED: Processing failed. TIMEOUT_FAILED: The task timeout did not complete. LIMIT_RETRY_FAILED: Exceeded maximum number of retries for processing failures.
+image_list	array of string		HD color migration processing results.

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.

Business Parameters [type = GENERATE_CARTOONIZED_IMAGE]

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: The task is queued. PROCESSING: Asynchronous processing. PROCESS_SUCCESS: Processing was successful. PROCESS_FAILED: Processing failed. TIMEOUT_FAILED: The task timeout did not complete. LIMIT_RETRY_FAILED: Exceeded maximum number of retries for processing failures.
+result_url	string		AI Cartoon Generator processing results.

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.

Example

[type = HD_COLOUR_MIGRATION]

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

[type = GENERATE_CARTOONIZED_IMAGE]

{
  "request_id":     "",
  "log_id":         "",
  "error_code":     0,
  "error_code_str": "",
  "error_msg":      "",
  "error_detail":   {
    "status_code":  200,
    "code":         "",
    "code_message": "",
    "message":      ""
  },
  "data":           {
    "status":     "PROCESS_SUCCESS",
    "result_url": "https://www.ailabtools.com/logo.webp"
  }
}

Code example

• Introduction
• Code example