API Reference
Interactive reference for every Lingopal v2 public API endpoint.
Browse endpoints by workflow. Each page includes request fields, response schemas, code samples, and interactive request controls.
Job Outputs
Download job subtitle
Downloads generated subtitles for a registered job as SRT or VTT.
Download job transcript
Downloads a transcript for a registered job as JSON, CSV, TSV, or plain text.
Export job transcript with selected columns
Exports a transcript for a registered job with optional include/exclude controls.
Job Registration
Register jobs for later use
Registers one or more uploaded or externally hosted file URLs as Lingopal media/document records. This endpoint records source metadata only; processing inputs such as target languages and translation context are supplied later through the appropriate `/v2/jobs/{job_id}` workflow endpoint. Per-item failures are returned in the `results` array with `status="error"`.
Upload and register a small file
Uploads a small file directly to Lingopal and registers it as media or a document. For files larger than the direct upload limit, use `/v2/storage/uploads` multipart upload. Provide target languages and translation context later through the appropriate `/v2/jobs/{job_id}` workflow endpoint.
Job Workflows
Generate subtitles for a registered job
Starts translated subtitle generation for a reusable registered media file.
Republish translated job media
Regenerates already translated target media and requires completed translated artifacts for every target.
Retry failed language translation
Re-triggers translation for a single failed locale. Up to 2 retries are allowed per language; each retry deducts credits for the locale.
Retry failed media translation
Re-triggers the parent translate-media workflow for media that failed before any language reached a ready state.
Transcribe a registered job
Creates source transcript artifacts without translating registered audio or video media.
Translate a registered job
Starts translation for a reusable registered job. Video/audio files use the media translation workflow; NG media translation transcribes the source first when needed. Document files use the document translation workflow.
Jobs
Languages
Storage
Complete a multipart storage upload
Completes an S3 multipart upload created by `/v2/storage/uploads`. Only uploads owned by the authenticated user can be completed.
Create a presigned storage upload
Returns one or more presigned S3 upload URLs for uploading a source file before registering it with `/v2/jobs/register`. Provide `file_size` to request a multipart upload.
Text Translation
Machine-readable contract: OpenAPI v2 JSON. Requests authenticate through the X-API-Key header.