Translate documents
Register a document, start its translation workflow with optional context, and monitor available outputs.
Documents use the same reusable job model as media.
1. Register the document
Use Upload and register source files. Set media_type to document when inference would be ambiguous, then save the returned job_id.
2. Start translation
export LINGOPAL_API_KEY="your-api-key"
export JOB_ID="replace-with-job-id"
curl -X POST "https://api.lingopal.ai/v2/jobs/$JOB_ID/translations" \
-H "X-API-Key: $LINGOPAL_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"target_languages": ["es", "fr"],
"context": "Legal agreement. Preserve clause numbering and product names.",
"reset": true
}'Authorization
APIKeyHeader In: header
Path Parameters
Reusable registered job ID returned by /v2/jobs/register or /v2/jobs/upload-and-register.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
curl -X POST "https://example.com/v2/jobs/job_123/translations" \ -H "Content-Type: application/json" \ -d '{ "target_languages": [ "es", "fr" ] }'{ "workflow": "translate_media", "status": "started", "job_id": "job_123", "target_languages": [ "es", "fr" ], "message": "Translation workflow started", "links": { "job": "/v2/jobs/job_123", "status": "/v2/jobs/job_123/status" }}Use the API Reference entry for translateJob for full request and response options.
The job type selects the document workflow. Use context to provide document-specific terminology and formatting guidance. Only send optional media-processing fields when your integration explicitly needs them.
3. Monitor status
Poll GET /v2/jobs/{job_id}/status and inspect workflows.translation, outputs, and error. See Job lifecycle.
The current public contract exposes status and job metadata but no dedicated translated-document download operation. Treat the output flags and links returned by your account's API response as authoritative; contact Lingopal if your integration requires a document artifact URL.