API Reference
API v2 (Current Version)
Internationalization
Download File

Download Translated i18n File

Download a translated i18n file for a specific target language.

Endpoint

GET /v2/translate/i18n/jobs/{job_id}/download

Description

Download a translated i18n file for a specific target language. The file will be downloaded with the same format and structure as the original, with only values translated.

⚠️

Authentication Required: This endpoint requires a valid API key. Include your API key in the X-API-KEY header.

Headers

HeaderRequiredDescription
X-API-KEYYesYour API key for authentication

Authentication

This endpoint requires authentication via API key. Include your API key in the request headers:

X-API-KEY: your_api_key_here

Path Parameters

job_id string (UUID, required) : The unique identifier of the translation job

Query Parameters

language_code string (required) : Target language code (e.g., "fr", "es", "de")

Example Request

curl -X GET "https://v2-api.translateplus.io/v2/translate/i18n/jobs/550e8400-e29b-41d4-a716-446655440000/download?language_code=fr" \
  -H "X-API-KEY: your_api_key" \
  -o translations_fr.json

Success Response (200 OK)

The response is the translated file with the same format as the original. The file is downloaded with a filename in the format: {original_filename}_{language_code}.{extension}

ℹ️

File Structure: The downloaded file maintains the exact same structure, format, and encoding as the original. Only values are translated; keys, placeholders, and formatting remain unchanged.

Supported File Formats:

  • JSON (.json) - Web applications (React, Vue, Angular)
  • YAML (.yaml, .yml) - Configuration files, web applications
  • PO/POT (.po, .pot) - GNU gettext, desktop applications
  • Properties (.properties) - Java applications, resource bundles
  • Strings (.strings) - iOS applications
  • XML (.xml) - Android applications, resource files

The file format is automatically detected from the original uploaded file. The downloaded file will have the same format as the original.

Error Responses

400 Bad Request

Missing language_code parameter:

{
  "error": "language_code parameter is required"
}

401 Unauthorized / 403 Forbidden

Invalid or missing API key:

{
  "detail": "Invalid API key. Please verify your API key is valid."
}

404 Not Found

File not found:

{
  "error": "Translated file for language fr not found"
}