DocsICP FilingConsole
Documentation

SubmitDocTranslateTask

Updated at:
Copy as MD
Product
My Favorites

Submit a document translation task to 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.

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:SubmitDocTranslateTask

none

*All Resource

*

NoneNone

Request syntax 

POST /anytrans/translate/doc/submit HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

workspaceId

string

Yes

The ID of the Model Studio workspace for the current request.

llm-kqtrcpdee4xm29xc

format

string

No

The format for the translation.

text

sourceLanguage

string

Yes

The source language code.

zh

targetLanguage

string

No

The target language code.

en

text

string

Yes

The URL of the document to translate.

https://xxx-hangzhou.aliyuncs.com/docs/tmp/%E6%A0%B7%E4%BE%8B_%E6%97%A0%E5%9B%BE.pdf

scene

string

Yes

The translation model.

mt-turbo

ext

object

No

Extension parameters that control translation features.

domainHint

string

No

A prompt that tailors the translation style to a specific domain.

This text comes from a rigorous academic paper. Please provide a translation that complies with academic standards.

terminologies

array<object>

No

The glossary to apply to the translation.

object

No

A glossary entry to apply.

tgt

string

No

The custom translation for the corresponding source term.

ML

src

string

No

The source text that the custom translation will replace.

机器学习

config

object

No

Configuration settings for the translation job.

skipImgTrans

boolean

No

Specifies whether to translate images in PDF documents.

false

isBilingual

boolean

No

Specifies whether to generate a bilingual document containing both the source and target text.

false

paramMap

any

No

A map for advanced configuration. Use bizUserId to apply terminologies on a per-user basis and bizType to apply them on a per-scenario basis. This prevents terminology conflicts between different users or scenarios.

{"bizUserld":"123456","bizType":session"}

trackingData

string

No

User-defined pass-through data. The service does not process this data and returns it as-is in the response. This is useful for scenarios such as 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, used to trace the API call.

377A48D7-7CFA-53F9-8CA2-14FE3F2774B6

success

boolean

Indicates whether the call was successful.

Valid values:

  • true :

    The call was successful.

  • false :

    The call failed.

true

httpStatusCode

string

The HTTP status code.

200

data

object

The response data.

taskId

string

The document translation task ID.

d3a2397bc2c14ab4a2e40a4f5b46241b

status

string

The task status.

ready

trackingData

string

User-defined passthrough data. The translation service returns this data without processing it. This is useful for analytics tracking.

{"traceId":"trace_123456"}

Examples

Success response

JSON format

{
  "code": "success",
  "message": "success",
  "requestId": "377A48D7-7CFA-53F9-8CA2-14FE3F2774B6",
  "success": true,
  "httpStatusCode": "200",
  "data": {
    "taskId": "d3a2397bc2c14ab4a2e40a4f5b46241b",
    "status": "ready",
    "trackingData": "{\"traceId\":\"trace_123456\"}"
  }
}

Error codes

HTTP status code

Error code

Error message

Description

400IdempotentParameterMismatchThe 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.
429Request.RateLimit.UserControlRequest Rate Limit User Control.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.