SDK Usage Guide

Billing notes

OpenAPI calls themselves incur no additional charges. Billing occurs only when the translation task actually runs, deducted in Credits. The billing rules are exactly the same as those in the console.

• Uploading a file (UploadTranslationFile) is free of charge and only provides estimated Credits consumption.

• Billing starts after submitting a translation task (SubmitTranslationTask).

• After a task is cancelled, all frozen Credits are fully refunded.

For detailed billing and deduction order, see Billing.

Product information

Install the SDK

// Add the dependency to pom.xml:
<dependency>
    <groupId>com.aliyun</groupId>
    <artifactId>realtranslationagent20260622</artifactId>
    <version>1.0.3</version>
</dependency>

pip install alibabacloud_realtranslationagent20260622==1.0.3

npm install @alicloud/realtranslationagent20260622@1.0.3

go get github.com/alibabacloud-go/realtranslationagent-20260622/client@v1.0.3

dotnet add package AlibabaCloud.SDK.RealTranslationAgent20260622 --version 1.0.3

composer require alibabacloud/realtranslationagent-20260622 1.0.3

vcpkg install alibabacloud-sdk-realtranslationagent-20260622

// Add the dependency via Swift Package Manager in Package.swift:
.package(url: "https://github.com/alibabacloud-sdk-swift/realtranslationagent-20260622", from: "1.0.3")

Initialize the client

import com.aliyun.realtranslationagent20260622.Client;
import com.aliyun.teaopenapi.models.Config;

Config config = new Config()
        .setAccessKeyId("your-access-key-id")
        .setAccessKeySecret("your-access-key-secret")
        .setEndpoint("realtranslationagent.aliyuncs.com");

Client client = new Client(config);

from alibabacloud_realtranslationagent20260622.client import Client
from alibabacloud_tea_openapi.models import Config

config = Config(
    access_key_id="your-access-key-id",
    access_key_secret="your-access-key-secret",
    endpoint="realtranslationagent.aliyuncs.com"
)

client = Client(config)

import Client from '@alicloud/realtranslationagent20260622';
import { Config } from '@alicloud/openapi-client';

const config = new Config({
    accessKeyId: 'your-access-key-id',
    accessKeySecret: 'your-access-key-secret',
    endpoint: 'realtranslationagent.aliyuncs.com',
});

const client = new Client(config);

import (
    client "github.com/alibabacloud-go/realtranslationagent-20260622/client"
    openapi "github.com/alibabacloud-go/darabonba-openapi/v2/client"
    "github.com/alibabacloud-go/tea/tea"
)

config := &openapi.Config{
    AccessKeyId:     tea.String("your-access-key-id"),
    AccessKeySecret: tea.String("your-access-key-secret"),
    Endpoint:        tea.String("realtranslationagent.aliyuncs.com"),
}

c, err := client.NewClient(config)

using AlibabaCloud.SDK.RealTranslationAgent20260622;
using AlibabaCloud.OpenApiClient.Models;

var config = new Config
{
    AccessKeyId = "your-access-key-id",
    AccessKeySecret = "your-access-key-secret",
    Endpoint = "realtranslationagent.aliyuncs.com"
};

var client = new Client(config);

use AlibabaCloud\SDK\RealTranslationAgent\V20260622\RealTranslationAgent;
use Darabonba\OpenApi\Models\Config;

$config = new Config([
    'accessKeyId' => 'your-access-key-id',
    'accessKeySecret' => 'your-access-key-secret',
    'endpoint' => 'realtranslationagent.aliyuncs.com',
]);

$client = new RealTranslationAgent($config);

Workflow overview

Core flows in detail

Task status reference

Full code example

import com.aliyun.realtranslationagent20260622.Client;
import com.aliyun.realtranslationagent20260622.models.*;
import com.aliyun.teaopenapi.models.Config;
import com.aliyun.teautil.models.RuntimeOptions;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

public class TranslationExample {

    public static void main(String[] args) throws Exception {
        // 1. Initialize the client
        Config config = new Config()
                .setAccessKeyId("your-access-key-id")
                .setAccessKeySecret("your-access-key-secret")
                .setEndpoint("realtranslationagent.aliyuncs.com");
        Client client = new Client(config);

        // 2. Upload the file and preview estimate
        File file = new File("/path/to/document.docx");
        InputStream fileStream = new FileInputStream(file);

        UploadTranslationFileAdvanceRequest uploadRequest =
                new UploadTranslationFileAdvanceRequest()
                        .setFileObject(fileStream)
                        .setFileName(file.getName());
        // Member accounts must set the API Key
        // uploadRequest.setAPIKey("your-api-key");

        RuntimeOptions runtimeOptions = new RuntimeOptions();
        UploadTranslationFileResponse uploadResponse =
                client.uploadTranslationFileAdvance(uploadRequest, runtimeOptions);

        String taskId = uploadResponse.getBody().getData().getTaskId();
        System.out.println("TaskId: " + taskId);
        System.out.println("Estimated Credits: " + uploadResponse.getBody().getData().getEstimatedCostCredits());

        // 3. Submit the translation task
        SubmitTranslationTaskRequest.SubmitTranslationTaskRequestConfig translateConfig =
                new SubmitTranslationTaskRequest.SubmitTranslationTaskRequestConfig()
                        .setSourceLanguage(uploadResponse.getBody().getData().getDetectedLang())
                        .setTargetLanguage("en")
                        .setFont("Calibri");

        // Custom terms (optional)
        List<SubmitTranslationTaskRequest.SubmitTranslationTaskRequestCustomTerms> customTerms = new ArrayList<>();
        customTerms.add(new SubmitTranslationTaskRequest.SubmitTranslationTaskRequestCustomTerms()
                .setSourceTerm("人工智能")
                .setTargetTerm("Artificial Intelligence"));

        SubmitTranslationTaskRequest submitRequest = new SubmitTranslationTaskRequest()
                .setTaskId(taskId)
                .setConfig(translateConfig)
                .setCustomTerms(customTerms);

        SubmitTranslationTaskResponse submitResponse = client.submitTranslationTask(submitRequest);
        System.out.println("Status: " + submitResponse.getBody().getData().getStatus());

        // 4. Poll task progress
        String status;
        do {
            Thread.sleep(5000);
            GetTranslationTaskRequest getRequest = new GetTranslationTaskRequest()
                    .setTaskId(taskId);
            GetTranslationTaskResponse getResponse = client.getTranslationTask(getRequest);
            status = getResponse.getBody().getData().getStatus();
            System.out.println("Progress: " + getResponse.getBody().getData().getProgress() + "%, Status: " + status);
        } while ("PENDING".equals(status) || "PROCESSING".equals(status));

        // 5. Download the translated file
        if ("COMPLETED".equals(status)) {
            GetTranslatedFileUrlRequest downloadRequest = new GetTranslatedFileUrlRequest()
                    .setTaskId(taskId);
            GetTranslatedFileUrlResponse downloadResponse = client.getTranslatedFileUrl(downloadRequest);
            System.out.println("Download URL: " + downloadResponse.getBody().getData().getDownloadUrl());
        }
    }
}