tencent cloud

Coloring an Image
Download PDF
Last updated: 2025-09-09 20:02:19
Coloring an Image
Last updated: 2025-09-09 20:02:19
Download PDF

Feature Description

Tencent Cloud Data Infinite uses the AIImageColoring API to colorize black and white images.
Note:
API carries a signature. Processing during download is required. Request parameters must be included in the signature.

Authorization Description

When using with a sub-account, corresponding permissions need to be granted. For COS permissions, please refer to COS action. For CI permissions, please refer to Cloud Infinite action.
Processing during download: Set action to authorization policy cos:GetObject, ci:CreateAIImageColoringJob.
Process upon upload: Set action to authorization policy cos:PutObject.
Cloud data processing: Set action to authorization policy cos:GetObject, cos:PutObject (Note: The resource corresponding to GetObject is the source file, and the resource corresponding to PutObject is the transferred file).

Service Activation

Using this feature requires enabling Cloud Infinite in advance and binding a bucket.

Use Limits

When using this API, please confirm the relevant restrictions first. For details, see Usage Limits.

Fee Description

This API is a paid service. Generated costs will be charged by Cloud Infinite. For detailed billing instructions, please refer to Content recognition.


Processing Method 1: Processing during Download

Request

Request Syntax

 Original images are stored in COS. 
GET /<ObjectKey>?ci-process=AIImageColoring HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>
Original images come from other links.
GET /?ci-process=AIImageColoring&detect-url=<detect-url> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: <GMT Date>
Authorization: <Auth String>

Request Content

Operation name: AIImageColoring
Parameter
Meaning
Type
Required or Not
ObjectKey
object filename, for example: folder/document.jpg
String
No
ci-process
Cloud Infinite processing capability, image coloring parameter fixed as AIImageColoring
String
Yes
detect-url
You can process any publicly accessible image link by filling in detect-url. If detect-url is not filled in, the backend will default to processing the ObjectKey. If detect-url is filled in, the backend will process the detect-url link, and there is no need to fill in the ObjectKey.
detect-url example: http://www.example.com/abc.jpg, needs to be UrlEncoded, processed as http%3A%2F%2Fwww.example.com%2Fabc.jpg
String
No

Response

HTTP/1.1 200 OK
Content-Type: image/png
Content-Length: 98645
Date: Tue, 23 Apr 2022 09:06:16 GMT
Status: 200 OK
Server: tencent-ci
x-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****

[pic-content]
The processed image is returned directly in the response body.

Examples

Request

GET /filename.jpg?ci-process=AIImageColoring HTTP/1.1
Host: examplebucket-1250000000.cos.ap-chengdu.myqcloud.com
Date: Tue, 23 Apr 2022 09:06:16 GMT
Authorization: <Auth String>

Response

HTTP/1.1 200 OK
Content-Type: image/jpg
Content-Length: 98645
Date: Tue, 23 Apr 2022 09:06:16 GMT
Status: 200 OK
Server: tencent-ci
x-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****

[pic-content]

Processing Method 2: Process Upon Upload

Request

Request Syntax

PUT  /<ObjectKey> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Pic-Operations: <PicOperations>
Note:
Authorization: Carry authentication information. The request header used to verify the legitimacy of the request. The Pic-Operations header must be included in the check-in signature. For details, see the Request Signature document.

Request header

This API only uses common request headers. For details, see the Common Request Headers document.
In addition to common headers, the following headers need to be provided:
Header Name
Description
Type
Pic-Operations
Parameters for image operations
String
Pic-Operations is a json format string with the following specific parameters:
Parameter Name
Type
Required or Not
Description
is_pic_info
Int
No
Whether to return original image information, 0 for no return, 1 for return, default is 0
rules
Array
No
Processing rules, one rule corresponds to one processing result (currently supports five rules), leave blank to skip image processing
Each item in the rules (json array) has the following specific parameters:
Parameter Name
Type
Required or Not
Description
bucket
String
No
The name of the destination bucket for storing results, in the format BucketName-AppId. If not specified, it defaults to the current bucket.
fileid
String
Yes
Storage path and name of the processed file. Naming rules description:
For example, the file path and filename of the source file are: /p1/test1.jpg
Paths starting with / are absolute paths. For example, when the fileid value is /p2/test2.jpg, it means a file named test2.jpg is stored in the p2 folder.
Paths not starting with / are relative paths. For example, when the fileid value is p2/test2.jpg, it means a p2 folder is created in the p1 folder, and then a file named test2.jpg is stored in the p2 folder.
Do not end with /, otherwise an empty filename will occur.
If you want the repaired image to overwrite the original image, set the fileid field to <ObjectKey>
rule
String
Yes
Processing parameter, fixed as: ci-process = AIImageColoring

Request body.

The request body contains the original image to be colorized.
[Image Content]

Response

Response Headers

This API returns common response headers. For details, please refer to the Common Response Headers document.

Response Body

The response body returns content-type as application/xml. The specific data content is as follows:
Node Name (Keyword)
Parent Node
Description
Type
UploadResult
None.
Request result.
Container
The content of UploadResult
Node Name (Keyword)
Parent Node
Description
Type
OriginalInfo
UploadResult
Image information
Container
ProcessResults
UploadResult
Request processing result
Container
The content of the OriginalInfo node
Node Name
Parent Node
Description
Type
Key
OriginalInfo
Original image filename
String
Location
OriginalInfo
path to the image
String
ETag
OriginalInfo
Etag value of the original image

ProcessResults node content:
Node Name (Keyword)
Parent Node
Description
Type
Object
ProcessResults
processing result of each image
Container
Content of the Object node
Node Name (Keyword)
Parent Node
Description
Type
Key
Object
Colorized image file name
String
Location
Object
Colorized image link
String
ETag
Object
ETag value of the colorized image
String
Size
Object
Image size
Int

Examples

Request

PUT /<ObjectKey> HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Pic-Operations: 
{
  "is_pic_info": 1,
  "rules": [{
      "fileid": "exampleobject",
      "rule": "ci-process=AIImageColoring"
  }]
}

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 645
Date: Tue, 23 Apr 2022 09:06:16 GMT
Status: 200 OK
Server: tencent-ci
x-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****

<UploadResult>
    <OriginalInfo>
        <Key>ObjectKey</Key>
        <Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/filename.jpg</Location>
        <ETag>"ed60e3598e6862d8c8443a06acfb2153"</ETag>
    </OriginalInfo>
    <ProcessResults>
        <Object>
            <Key>exampleobject</Key>
            <Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location>
            <Format/>
            <Size>354256</Size>
            <ETag>"521451f63c331becf533e466732c1091"</ETag>
        </Object>
    </ProcessResults>
</UploadResult>

Processing Method 3: Cloud Data Processing

Request

Request Syntax

POST  /<ObjectKey>?image_process HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Authorization: Auth String
Pic-Operations: <PicOperations>
Note:
Authorization: Auth String. For details, see Request Signature document.

Request header.

This API only uses common request headers. For details, see the Common Request Headers document.
In addition to common headers, the following headers need to be provided:
Header Name
Description
Type
Pic-Operations
Parameters for image operations
String
Pic-Operations is a json format string with the following specific parameters:
Parameter Name
Type
Required or Not
Description
is_pic_info
Int
No
Whether to return original image information, 0 for no return, 1 for return, default is 0
rules
Array
No
Processing rules, one rule corresponds to one processing result (currently supports five rules), leave blank to skip image processing
Each item in the rules (json array) has the following specific parameters:
Parameter Name
Type
Required or Not
Description
bucket
String
No
The name of the destination bucket for storing results, in the format BucketName-AppId. If not specified, it defaults to the current bucket.
fileid
String
Yes
Storage path and name of the processed file. Naming rules description:
For example, the source file path and name are: /p1/test1.jpg
Paths starting with / are absolute paths. For example, when the fileid value is /p2/test2.jpg, it means a file named test2.jpg is stored in the p2 folder.
Paths not starting with / are relative paths. For example, when the fileid value is p2/test2.jpg, it means a p2 folder is created in the p1 folder, and then a file named test2.jpg is stored in the p2 folder.
Note: Do not end with /, otherwise an empty filename will occur.
If you want the repaired image to overwrite the original image, set the fileid field to <ObjectKey>
rule
String
Yes
Processing parameter, fixed as: ci-process=AIImageColoring

Request body.

Null

Response

Response Headers

This API returns common response headers. For details, please refer to the Common Response Headers document.

Response Body

The response body returns content-type as application/xml. The specific data content is as follows:
Node Name (Keyword)
Parent Node
Description
Type
UploadResult
None.
Request result.
Container
The content of UploadResult
Node Name (Keyword)
Parent Node
Description
Type
OriginalInfo
UploadResult
Image information
Container
ProcessResults
UploadResult
Request processing result
Container
The content of the OriginalInfo node
Node Name
Parent Node
Description
Type
Key
OriginalInfo
Original image filename
String
Location
OriginalInfo
path to the image
String
ETag
OriginalInfo
original image ETag
String
ProcessResults node content:
Node Name (Keyword)
Parent Node
Description
Type
Object
ProcessResults
processing result of each image
Container
Content of the Object node
Node Name (Keyword)
Parent Node
Description
Type
Key
Object
Colorized image file name
String
Location
Object
Colorized image link
String
ETag
Object
ETag value of the colorized image
String
Size
Object
Size of the colorized image
Int

Examples

Request

POST /<ObjectKey>?image_process HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
Content-length: Size
Authorization: Auth String
Pic-Operations: 
{
  "rules": [{
      "fileid": "exampleobject",
      "rule": "ci-process=AIImageColoring"
  }]
}
The processed image is stored in the bucket, with the field value of fileid used as the object name.

Response

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: 645
Date: Tue, 23 Apr 2022 09:06:16 GMT
Status: 200 OK
Server: tencent-ci
x-cos-request-id: NWFjMzQ0MDZfOTBmYTUwXzZkZV8z****

<UploadResult>
    <OriginalInfo>
        <Key>ObjectKey</Key>
        <Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/filename.jpg</Location>
        <ETag>"ed60e3598e6862d8c8443a06acfb2153"</ETag>
    </OriginalInfo>
    <ProcessResults>
        <Object>
            <Key>exampleobject</Key>
            <Location>examplebucket-1250000000.cos.ap-chengdu.myqcloud.com/exampleobject</Location>
            <Format/>
            <Size>354256</Size>
            <ETag>"521451f63c331becf533e466732c1091"</ETag>
        </Object>
    </ProcessResults>
</UploadResult>
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback