What is the endpoint for [T010]Translate Text?

The [T010]Translate Text endpoint is POST https://connect.patsnap.com/hiro_translation/translate.

What data can [T010]Translate Text return?

[T010]Translate Text Translate source text from source language to target language and return a single JSON result. See the Response Schema and Success Response Example on this page for the full structure.

Where can I find the OpenAPI schema for [T010]Translate Text?

The OpenAPI schema is available at /openapi.json#/paths/~1hiro_translation~1translate/post. You can also browse the full specification at /openapi.json.

[T010]Translate Text

post

https://connect.patsnap.com/hiro_translation/translate

Try in Sandbox

Translate source text from source language to target language and return a single JSON result.

content, sourceLanguageCode and targetLanguageCode are required. Both sourceLanguageCode and targetLanguageCode must be supported language codes (zh, en, ja, ko, de, fr, ru, es, pt, it, nl, ar, hi, th, vi, id, tr, pl) and must differ. content is limited to 65536 characters by default. mode supports stream and fast, defaulting to fast. stream: sliding-window sequential translation, returned segment by segment via SSE; later segments can leverage already-translated context within the window, maximizing consistency across the whole text. fast: concurrent segment-based translation that returns the complete JSON result in a single response, offering higher throughput but weaker cross-segment context consistency.

Request Parameters

List of parameters supported by this API endpoint

Name	Type	Example	Description
`content` Required	`string`	`本发明公开了一种档案管理文件储存用分类标识装置。`	Source text to translate. Must not be blank. Default max 65536 characters.
`mode`	`string`	`fast`	Translation mode. Supports fast and stream, defaulting to fast. fast: concurrent segment-based translation that returns the complete JSON result in a single response, offering higher throughput but weaker cross-segment context consistency. stream: sliding-window sequential translation, returned segment by segment via SSE; later segments can leverage already-translated context within the window, maximizing consistency across the whole text.
`sourceLanguageCode` Required	`string`	`zh`	Source language code. Supported: zh, en, ja, ko, de, fr, ru, es, pt, it, nl, ar, hi, th, vi, id, tr, pl.
`targetLanguageCode` Required	`string`	`en`	Target language code; must differ from source. Supported: zh, en, ja, ko, de, fr, ru, es, pt, it, nl, ar, hi, th, vi, id, tr, pl.

Request Example

Example request body for this API endpoint

JSON

{
  "mode": "fast",
  "content": "本发明公开了一种档案管理文件储存用分类标识装置。",
  "sourceLanguageCode": "zh",
  "targetLanguageCode": "en"
}

Response Schema

Structure of the API response data

Field Name	Type	Example	Description
`data`	`object`	-	response data
`state` Required	`string`	`success`	Execution status, always success
`textTranslated` Required	`string`	`The invention discloses a classified marking device for archive management file storage.`	Full translated text
`translatedCharacterCount` Required	`integer<int32>`	`82`	Character count of translated text
`status` Required	`boolean`	`false`	Status
`error_msg`	`string`	`The request parameter format is incorrect！`	Error Message
`error_code` Required	`integer`	`0`	Error Code

Success Response Example

Example of a successful API response

JSON

{
  "data": {
    "state": "success",
    "textTranslated": "The invention discloses a classified marking device for archive management file storage.",
    "translatedCharacterCount": 82
  },
  "status": true,
  "error_code": 0
}

Error Codes

List of possible error codes returned by this endpoint

Business Errors

Error Code	Description
`68300004`	Invalid parameter!
`68300005`	Search api failure!
`68300006`	Analytic basic access error!
`68300007`	Bad request!
`68300008`	Service error, please try again later!
`68300010`	The file does not comply with upload specifications!

Platform Errors

Error Code	Description
`67200000`	API call exceeds the total limit set by the platform!
`67200001`	API call exceeds the total limit set by the platform!
`67200002`	The current call rate is too fast, exceeding the current configuration limit QPS!
`67200003`	The key and secret parameters for applying for the token are incorrect or the client has been disabled!
`67200004`	The requested api does not have permission. Please contact our support personnel!
`67200005`	Insufficient account balance/number of calls!
`67200006`	The client has exceeded the activation validity period!
`67200007`	The current call exceeds the configured usage limit of the day!
`67200008`	Please check if the required apikey in the query parameter has been transmitted!
`67200009`	The apikey does not match the passed bearerToken. Please check if a valid token is being used!
`67200012`	The request is illegal!
`67200100`	The current server status is busy, request response timeout!
`67200101`	The API requested currently does not exist. Please check the request path!

HTTP Status Codes

Status Code	Description
`0`	Success
`201`	Created
`401`	Unauthorized
`403`	Forbidden
`404`	Not Found

Performance Metrics

Expected performance characteristics for this endpoint

Normal Response Time

5000 ms

Max Response Time

10000 ms