Documentation Index
Fetch the complete documentation index at: https://developers.phrase.com/llms.txt
Use this file to discover all available pages before exploring further.
Phrase BYO Engine API
Machine translation powered by Phrase allows the translation of content using a unique AI powered feature to pick the best available translation engine for that content. By implementing the following API it is possible to integrate custom machine translation engine directly into Phrase Language AI. A minimal BYO Engine machine translation API specification. It supports the following operations and features:- supported languages
- engine status
- multi-segment translation operations
- synchronous translation
- asynchronous translation
- with glossaries
- applies to both synchronous and asynchronous endpoints
- with custom metadata
- applies to both synchronous and asynchronous endpoints
Dynamic Metadata
Phrase automatically resolves the following placeholders in request-level metadata values before sending them to the engine:| Placeholder | Resolved value |
|---|---|
{project_uid} | TMS project UID |
{job_uid} | TMS job UID |
{idm_organization_uid} | Phrase organization UID |
Authentication
For authentication either the OAuth client credentials flow or an API token can be leveraged.Demo Implementation
A reference implementation of the adapter is available here. It demonstrates a basic integration and includes additional guidance.Technical Notes
- Implement your adapter in accordance with the OpenAPI schema.
- In general, but especially for the asynchronous endpoints, ensure thread safety and proper concurrency handling to prevent race conditions where concurrent requests could overwrite each other’s data.
Stability and Performance Recommendations
- DNS Infrastructure & Routing: Ensure DNS resolution is stable and all entries are correctly configured. Misconfigurations or propagation delays can result in intermittent resolution failures, elevated latency, or request timeouts.
- Application & Proxy Server Tuning (e.g., Nginx): Optimize your proxy or gateway servers for high-concurrency traffic. Review keep-alive settings and worker process limits to avoid TCP connection resets or dropped requests under load.
- Load & Concurrency Testing: Perform synthetic load tests from external endpoints before going to production. Validate your adapter against a sustained concurrency of 100–200 requests per second (RPS) to confirm that performance remains linear and stable.