Create a translation job
POST /v1/jobs/translation
This endpoint allows you to create a new translation job. You can either provide source files directly or configure a TMS connection.
Required attributes
string
required
The translation mode. Possible values:
ai, human. Currently only ai is supported.Optional attributes
string
Content domain for the translation (e.g., “technical”, “legal”, “marketing”).
array of integers
List of glossary IDs to use for terminology consistency.
array of integers
List of context store IDs to provide reference materials (styleguide content).
string
Segmentation mode:
default, sentence, paragraph, or document.string
Additional instructions for the AI translator.
array of strings
List of source file paths to translate. Required if no TMS is configured.
string
Source language code (e.g., “en”). Required if
source_files is provided.array of strings
Target language codes (e.g., [“de”, “fr”]). Required if
source_files is provided.object
TMS configuration object. Required if
source_files is not provided. Contains name (memoq, phrase, or xtm) and project_identifier.Response
Create a post-editing job
POST /v1/jobs/post-editing
This endpoint allows you to create a new AI post-editing (AIPE) job. Post-editing jobs revise machine-translated content to improve quality.
Required attributes
string
required
The post-editing mode. Possible values:
ai, human. Currently only ai is supported.object
required
TMS configuration object. Contains
name (memoq, phrase, or xtm) and project_identifier.Optional attributes
string
Content domain for the post-editing (e.g., “technical”, “legal”, “marketing”).
array of integers
List of glossary IDs to use for terminology consistency.
array of integers
List of context store IDs to provide reference materials (styleguide content).
string
Segmentation mode:
default, sentence, paragraph, or document.string
Additional instructions for the AI post-editor.
Response
Create a quality estimation job
POST /v1/jobs/quality-estimation
This endpoint allows you to create a new AI quality estimation (AIQE) job. Quality estimation jobs assess the quality of translations without a reference translation. The job runs against a TMS project configured via the tms object.
Optional attributes
object
TMS configuration object. Contains
name (memoq, phrase, or xtm) and project_identifier.Response
Create a term extraction job
POST /v1/jobs/term-extraction
This endpoint allows you to create a new term extraction job. Term extraction jobs extract terminology from a TMS project and create a new glossary with the extracted terms. Currently only memoQ is supported.
Required attributes
string
required
The name for the new glossary to be created with the extracted terms.
Optional attributes
string
Content domain for the term extraction (e.g., “technical”, “legal”, “marketing”).
object
TMS configuration object. Contains
name (memoq, phrase, or xtm) and project_identifier.Response
Create a language rewrite job
POST /v1/jobs/language-rewrite
This endpoint allows you to create a new language rewrite job. Language rewrite jobs transform content according to the selected rewrite type. You can either provide source files directly or configure a TMS connection.
Required attributes
string
required
The rewrite mode. Possible values:
ai, human. Currently only ai is supported.string
required
The rewrite type. Possible values:
simplify, summarize, elaborate, continue, align.Optional attributes
string
Content domain for the rewriting (e.g., “technical”, “legal”, “marketing”).
array of integers
List of context store IDs to provide reference materials (styleguide content).
string
Segmentation mode:
default, sentence, paragraph, or document (default: default).string
Additional instructions for the rewriting.
array of integers
List of glossary IDs to use for terminology consistency.
integer
Explicit prompt template ID override. If not specified, falls back to the organization default or system default for the given rewrite type.
array of strings
List of source files to rewrite. Required if no TMS is configured.
string
Source language code (e.g., “en”). Required if
source_files is provided.object
TMS configuration object. Contains
name (memoq, phrase, or xtm) and project_identifier. Required if source_files is not provided.Response
Create a quality assurance job
POST /v1/jobs/quality-assurance
This endpoint allows you to create a new quality assurance (QA) job for a TMS project. Once the job has completed, you can retrieve the results as an HTML report via the Get QA report endpoint.
Required attributes
string
required
The quality assurance mode. Possible values:
ai, human. Currently only ai is supported.object
required
TMS configuration object. Contains
name (memoq, phrase, or xtm) and project_identifier.Optional attributes
string
Content domain for the quality assurance (e.g., “technical”, “legal”, “marketing”).
array of integers
List of context store IDs to provide reference materials (styleguide content).
array of integers
List of glossary IDs to use for terminology consistency.
Response
Get QA report
GET /v1/jobs/qa-reports/:job_id
This endpoint allows you to retrieve the QA report for a completed quality estimation job. The response is an HTML document containing the quality assessment results.
Optional parameters
string
API key for authentication (alternative to the Authorization header, useful for browser access).
List translation jobs
GET /v1/jobs
This endpoint allows you to list recent jobs for your organization.
Optional parameters
integer
Maximum number of jobs to return (default: 50).
string
Filter by UI category (one of
video, audio, document, tms, system, human_task, other).string
Filter by exact workflow handler name (e.g.
dub_video, aimt, ppt_translation).Response
Get job status
GET /v1/jobs/:job_id
This endpoint allows you to retrieve the status of a specific job, including results if completed.
Response
Cancel a job
DELETE /v1/jobs/:job_id
This endpoint allows you to cancel a job if it’s still running.