SubmitImageTranslateTask
Use Tongyi multimodal translation to submit an image for translation.
Try it now
Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.
RAM authorization
The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:
-
Action: The actions can be used in the
Actionelement of RAM permission policy statements to grant permissions to perform the operation. -
API: The API that you can call to perform the action.
-
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
-
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
-
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
-
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.
Action | Access level | Resource type | Condition key | Dependent action |
|---|---|---|---|---|
anytrans:SubmitImageTranslateTask | none | *All Resource
| None | None |
Request syntax
POST /anytrans/translate/image/submit HTTP/1.1
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| workspaceId | string | Yes | The ID of the Model Studio workspace. | llm-kqtrcpdee4xm29xx |
| format | string | No | The translation format. | image |
| sourceLanguage | string | Yes | The source language. | zh |
| targetLanguage | array | Yes | A list of target languages. | |
string | No | A target language. | en | |
| text | string | Yes | The URL of the image to translate. | |
| scene | string | Yes | Specifies the translation model. Valid values:
| flash |
| ext | object | No | Extended parameters to control translation features. | |
| examples | array<object> | No | A list of translation examples. | |
object | No | A translation example. | ||
| tgt | string | No | The target text. | hello |
| src | string | No | The source text. | 你好 |
| domainHint | string | No | An English string that guides the translation style of the large language model (LLM). | this sentence from an e-commerce product image, please provide a translation that is both highly concise and no more than 1.2 times the length of the original. |
| sensitives | array | No | A list of sensitive words. | |
string | No | A sensitive word to filter. | password | |
| terminologies | array<object> | No | A list of custom term pairs to apply to the translation. | |
object | No | A term pair for custom translation. | ||
| tgt | string | No | The custom translation for the source text. | ML |
| src | string | No | The source text. | 机器学习 |
| textTransform | object | No | Specifies case conversion for the translated text. | |
| toLower | boolean | No | Set to Valid values:
| false |
| toUpper | boolean | No | Set to Valid values:
| false |
| toTitle | boolean | No | Set to Valid values:
| false |
| paramMap | any | No | Parameters for isolating terminology to prevent interference between different users or business scenarios. Use Valid values:
| {"bizUserld":"123456","bizType":session"} |
| trackingData | string | No | User-defined pass-through data that the service returns unmodified in the response. This is typically used for analytics tracking. | {"traceId":"trace_123456"} |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | The response schema. | ||
| code | string | The response error code. | success |
| message | string | The response message. | success |
| requestId | string | The request ID, used for tracing API calls. | 42FF90E5-5D40-5797-AAF6-8A4D837CCCD5 |
| success | boolean | Indicates whether the call was successful. Valid values:
| true |
| httpStatusCode | string | The HTTP status code. | 200 |
| data | object | The returned data. | |
| taskId | string | The ID of the image translation task. | 2746f4be-cff2-465e-a2c6-12bff30ce0f9 |
| status | string | The status of the translation task. Valid values:
| success |
| trackingData | string | User-defined passthrough data returned unmodified in the response, which is useful for tracking purposes. | {"traceId":"trace_123456"} |
Examples
Success response
JSON format
{
"code": "success",
"message": "success",
"requestId": "42FF90E5-5D40-5797-AAF6-8A4D837CCCD5",
"success": true,
"httpStatusCode": "200",
"data": {
"taskId": "2746f4be-cff2-465e-a2c6-12bff30ce0f9",
"status": "success",
"trackingData": "{\"traceId\":\"trace_123456\"}"
}
}
Error codes
HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.