Skip to main content
POST
Create a translation job

Authorizations

Authorization
string
header
required

Use API-Key YOUR_API_KEY. The key selects the Production or Development environment.

Path Parameters

studyId
string<uuid>
required

Body

application/json

Input for starting asynchronous Study translation generation.

targetLocale
string
required

One BCP 47 locale token.

Required string length: 2 - 35
Pattern: ^[A-Za-z]{2,3}(?:-[A-Za-z0-9]{2,8})*$
mode
enum<string>

Whether generation fills only missing values or replaces every translated value.

Available options:
FILL_MISSING,
REPLACE_ALL

Response

Accepted. The Location header points at the created job.

Canonical state and result metadata for one asynchronous translation job.

id
string<uuid>
required
targetLocale
string
required
mode
enum<string>
required

Whether generation fills only missing values or replaces every translated value.

Available options:
FILL_MISSING,
REPLACE_ALL
status
enum<string>
required

PENDING and RUNNING jobs can be cancelled. CANCELLED means no further translation output will be persisted. COMPLETED and FAILED are terminal. Cancelling does not roll back translations already committed by a completed job.

Available options:
PENDING,
RUNNING,
COMPLETED,
FAILED,
CANCELLED
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
progress
object
result
object
error
object

Failure details recorded for an asynchronous translation job.