API Reference
API v2 (Current Version)
Internationalization
List Jobs

List i18n Translation Jobs

Retrieve a list of all i18n translation jobs for the authenticated user.

Endpoint

GET /v2/translate/i18n/jobs

Description

Retrieve a list of all i18n translation jobs for the authenticated user. This endpoint returns all jobs regardless of their status.

Headers

X-API-KEY string (required) : Your API key for authentication

Example Request

curl -X GET "https://api.translateplus.io/v2/translate/i18n/jobs" \
  -H "X-API-KEY: your_api_key"

Success Response (200 OK)

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "job_id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed",
    "original_filename": "translations.json",
    "file_type": "json",
    "source_language": "en",
    "target_languages": ["fr", "es", "de"],
    "total_keys": 150,
    "translated_keys": 150,
    "failed_keys": 0,
    "error_message": null,
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:32:15Z",
    "completed_at": "2025-01-15T10:32:15Z"
  },
  {
    "id": "660e8400-e29b-41d4-a716-446655440001",
    "job_id": "660e8400-e29b-41d4-a716-446655440001",
    "status": "processing",
    "original_filename": "messages.yaml",
    "file_type": "yaml",
    "source_language": "en",
    "target_languages": ["fr"],
    "total_keys": 75,
    "translated_keys": 45,
    "failed_keys": 0,
    "error_message": null,
    "created_at": "2025-01-15T11:00:00Z",
    "updated_at": "2025-01-15T11:01:30Z",
    "completed_at": null
  }
]

Response Fields

FieldTypeDescription
idstring (UUID)Job unique identifier
job_idstring (UUID)Job unique identifier (same as id)
statusstringCurrent job status: "pending", "processing", "completed", "partial", or "failed"
original_filenamestringName of the uploaded file
file_typestringFile format: "json", "yaml", "po", "properties", "strings", or "xml"
source_languagestringSource language code
target_languagesarray[string]List of target language codes
total_keysintegerTotal number of translatable keys in the file
translated_keysintegerNumber of successfully translated keys
failed_keysintegerNumber of keys that failed to translate
error_messagestring | nullError message if the job failed
created_atstring (ISO 8601)Timestamp when the job was created
updated_atstring (ISO 8601)Timestamp when the job was last updated
completed_atstring (ISO 8601) | nullTimestamp when the job was completed, or null if still processing

Notes

  • Jobs are returned in reverse chronological order (newest first)
  • Only jobs belonging to the authenticated user are returned
  • Use the job_id to check detailed status or download translated files
  • Jobs remain in the list even after completion or failure

Error Responses

401 Unauthorized / 403 Forbidden

Invalid or missing API key:

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