API Reference
API v2 (Current Version)
Internationalization
Get Job Status

Get i18n Job Status

Retrieve the current status and details of an i18n translation job.

Endpoint

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

Description

Retrieve the current status and details of an i18n translation job. Use this endpoint to check if your translation job has completed and to get information about translated files.

Headers

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

Path Parameters

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

Example Request

curl -X GET "https://v2-api.translateplus.io/v2/translate/i18n/jobs/550e8400-e29b-41d4-a716-446655440000/status" \
  -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",
  "translated_files": [
    {
      "id": "660e8400-e29b-41d4-a716-446655440001",
      "language_code": "fr",
      "file_url": "https://v2-api.translateplus.io/v2/translate/i18n/jobs/550e8400-e29b-41d4-a716-446655440000/download/?language_code=fr",
      "file_size": 15234,
      "created_at": "2025-01-15T10:32:10Z"
    },
    {
      "id": "660e8400-e29b-41d4-a716-446655440002",
      "language_code": "es",
      "file_url": "https://v2-api.translateplus.io/v2/translate/i18n/jobs/550e8400-e29b-41d4-a716-446655440000/download/?language_code=es",
      "file_size": 15189,
      "created_at": "2025-01-15T10:32:12Z"
    }
  ]
}

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
translated_filesarrayList of translated files available for download
translated_files[].idstring (UUID)Unique identifier for the translated file
translated_files[].language_codestringTarget language code
translated_files[].file_urlstringURL to download the translated file via API endpoint (requires authentication)
translated_files[].file_sizeintegerSize of the translated file in bytes
translated_files[].created_atstring (ISO 8601)Timestamp when the file was created

Job Status Values

StatusDescription
pendingJob is queued and waiting to be processed
processingJob is currently being processed
completedJob completed successfully with all translations
partialJob completed but some translations failed
failedJob failed to process

Error Responses

404 Not Found

Job not found:

{
  "detail": "Job not found."
}

401 Unauthorized / 403 Forbidden

Invalid or missing API key:

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