SubmitHtmlTranslateTask-阿里云帮助中心

Submitting an HTML translation task with Tongyi Multimodal 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.

Test

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 Action element 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 Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
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:SubmitHtmlTranslateTask

none

*All Resource

*

None

Request syntax

POST /anytrans/translate/html/submit HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
workspaceId	string	Yes	The ID of the Model Studio workspace used for this request.	llm-kqtrcpdee4xm29xx
format	string	No	The format of the input text.	text
sourceLanguage	string	No	The source language.	zh
targetLanguage	string	No	The target language.	en
text	string	No	The HTML content to be translated.	我的第一个网页欢迎来到我的网页！这是一个简单的 HTML 页面。学习 HTML 是进入网页开发的第一步。点击这里访问示例网站
scene	string	No	The translation model. Valid values: mt-plus : Professional Edition mt-turbo : Lite Edition	mt-turbo
ext	object	No	Extended parameters to control translation behavior.
examples	array<object>	No	A list of translation examples.
	object	No	A translation example.
tgt	string	No	The target text in the example.	hello
src	string	No	The source text in the example.	你好
domainHint	string	No	A natural language prompt in English to guide the model's translation style.	his 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 to filter from the translation.
	string	No	A sensitive word to filter.	password
terminologies	array<object>	No	A list of custom terminology pairs to apply to the translation.
	object	No	A terminology pair to enforce.
tgt	string	No	The target text for the terminology pair.	ML
src	string	No	The source text for the terminology pair.	机器学习
textTransform	object	No	Specifies case transformations for the translated text.
toLower	boolean	No	Converts the entire translated text to lowercase. Valid values: true : Converts the text to lowercase. false : Does not convert the text.	false
toUpper	boolean	No	Converts the entire translated text to uppercase. Valid values: true : Converts the text to uppercase. false : Does not convert the text.	false
toTitle	boolean	No	Converts the translated text to title case. Valid values: true : Converts the text to title case. false : Does not convert the text.	false
config	object	No	Provides specific configuration settings for the translation task.
skipCsiCheck	boolean	No	Specifies whether to skip the Content Moderation check. To skip this check, you must first complete the Content Moderation disablement process before calling the API. Valid values: true : Skips the Content Moderation check. false : Performs the Content Moderation check.	false
callbackUrl	string	No	The callback URL for receiving translation results.
paramMap	any	No	Provides extended parameter configuration. The `bizUserId` key specifies the business user ID to isolate custom terminology enforcement by user. The `bizType` key specifies the business scenario type to isolate custom terminology enforcement by scenario. Valid values: bizType : Business scenario type bizUserId : Business user ID	{"bizUserld":"123456","bizType":session"}
trackingData	string	No	Custom passthrough data that the service returns unprocessed in the response. Useful for tasks such as event tracking.	{"traceId":"trace_123456"}

Response elements

Element	Type	Description	Example
	object	Response schema.
code	string	The response status code.	success
message	string	The response message.	success
requestId	string	The request ID. Use it to trace the API call.	72E4FDA1-5474-5DC1-8DFF-968BEEA65C49
success	boolean	Indicates whether the API call was successful. Valid values: true : The operation was successful. false : The operation failed.	true
httpStatusCode	string	The HTTP status code.	200
data	object	The response data.
taskId	string	The HTML translation task ID.	2746f4be-cff2-465e-a2c6-12bff30ce0f9
status	string	The translation task status. Valid values: in_process : The task is in progress. success : The task has succeeded.	in_process
trackingData	string	User-defined tracking data that the service returns as-is. Use this parameter for data tracking.	{"traceId":"trace_123456"}

Examples

Success response

JSON format

{
  "code": "success",
  "message": "success",
  "requestId": "72E4FDA1-5474-5DC1-8DFF-968BEEA65C49",
  "success": true,
  "httpStatusCode": "200",
  "data": {
    "taskId": "2746f4be-cff2-465e-a2c6-12bff30ce0f9\n",
    "status": "in_process",
    "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.