Skip to content

Translate Thread

POST
/inbox/{reply_id}/translate

Translate an email thread into English, cached per message. THIS SPENDS CREDITS for uncached messages.

Returns cached translations plus up to 10 newly translated messages (newest first); has_more asks you to call again. 404 when the thread is missing or its mailbox is not visible to the key (checked before anything is charged), 402 when the organisation lacks credits, 502 when every model call in the batch failed. Delivers nothing.

Authorizations

Parameters

Path Parameters

reply_id
required

Email thread id: the id of a thread returned by GET /inbox.

string

Email thread id: the id of a thread returned by GET /inbox.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Translate an email thread’s messages.

object
target_lang

Target ISO 639-1 language; only English for now.

string
default: en

Responses

200

Successful Response

object
data
required

An open envelope for a comment, an assignment or a workspace.

Open because a comment carries attachment refs and mention metadata that grow, and because an assignment result reports per-assignee outcomes.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string