Skip to main content
POST
Create a pre-translation job

Authorizations

Authorization
string
header
required

Enter your token in the format token TOKEN

Headers

X-PhraseApp-OTP
string

Two-Factor-Authentication token (optional)

Path Parameters

project_id
string
required

Project ID

Body

application/json
translatable_type
enum<string>

Resource type to pre-translate.

Available options:
locale,
job,
translation_key,
upload
translatable_id
string

ID of the targeted resource: locale ID for locale, job ID for job, key ID for translation_key, upload ID for upload.

Response

Accepted

id
string
Example:

"abcd1234cdef1234abcd1234cdef1234"

status
enum<string>

Current execution state of the pre-translation job. Jobs start as pending while queued, transition to running while executing, and settle to success or error.

Available options:
pending,
running,
success,
error
translatable_type
enum<string>

Resource type that was pre-translated.

Available options:
locale,
job,
translation_key,
upload
translatable_id
string

ID of the targeted resource (locale ID, job ID, key ID, or upload ID).

Example:

"abcd1234cdef1234abcd1234cdef1234"

error
string | null

Error message. null unless the job's status is error.

created_at
string<date-time>
updated_at
string<date-time>