Get Descriptions of Images
Action DescribeImages
Introduction
This interface is used to get descriptions of images.
Request
| Parameter Name | Type | Description | Required |
|---|---|---|---|
| Action | String | The corresponding API instruction name | ✓ |
| PublicKey | String | User's public key, which can be obtained from the PICPIK User Center (opens in a new tab) | ✓ |
| Signature | String | User's signature generated based on the public key and API instruction, see Signature for details | ✓ |
| request_uuid | String | Request UUID, randomly generated by using the UUID generation method. This parameter can be utilized to manage the requests of your business and clients. |
| Parameter Name | Type | Description | Required |
|---|---|---|---|
| ImageList | []String | Base64 list of images that need to be parsed | ✓ |
| TranslateDescription | String | The language that needs to be converted to, reference value: language list. Default: en |
Support Language List
| Language Code | Description |
|---|---|
| en | English |
| zh | Chinese |
| ja | Japanese |
| ko | Korean |
| fr | French |
| es | Spanish |
| it | Italian |
| de | German |
| tr | Turkish |
| ru | Russian |
| pt | Portuguese |
| vi | Vietnamese |
| id | Indonesian |
| th | Thai |
| ms | Malay |
Request Example
{
"Action":"DescribeImages",
"PublicKey":"ALLak9M4cNdHXKOJAJJ4k8Hh1hZS2EgJF1D0FlPwfl",
"Signature":"2e3ded4d95337e8e0e76c05f056ff958eb98f062",
"request_uuid":"15ba36f2-2d69-40bd-9e0c-3e73f0f5acd0",
"ImageList": ["data:image/jpeg;base64,xxx","data:image/jpeg;base64,xxx"]
}Response
| Field Name | Type | Description | Required |
|---|---|---|---|
| RetCode | Int | Return status code: 0 indicates a successful return, while non-zero indicates a failure | ✓ |
| Action | String | Instruction name | ✓ |
| Message | String | The error message is returned when RetCode is non-zero, providing a detailed description | |
| request_uuid | String | Returns the UUID that was included in the request |
| Parameter Name | Type | Description | Required |
|---|---|---|---|
| TaskUID | String | Task UID, used to query task details and get results. | ✓ |
Response Example
{
"Action": "DescribeImages",
"RetCode": 0,
"Message": "",
"request_uuid": "8482d350-04f9-421b-817b-1d98b3a4dcfa",
"TaskUID": "cktlm6lrh4xxx8ng9nf0"
}