Documentation de l'API

Organe de demande

* Utilisation target_language (chaîne) pour une seule langue ou target_languages (array) pour plusieurs. Voir Traduction multi-objectifs.

Réponse

{
    "translated_text": "Hola, mundo!",
    "source_language": "en",
    "target_language": "es",
    "translations": {
        "es": "Hola, mundo!"
    },
    "character_count": 13,
    "translation_time": 0.45
}

Organe de demande

{
    "text": "Hello, world!",
    "target_languages": ["es", "fr", "de", "ja"],
    "source_language": "en"
}

Utilisation target_languages (recours) au lieu de target_language (chaîne) pour plusieurs cibles.

Réponse

{
    "source_language": "en",
    "translations": {
        "es": "Hola, mundo!",
        "fr": "Bonjour, monde!",
        "de": "Hallo, Welt!",
        "ja": "こんにちは、世界！"
    },
    "character_count": 52,
    "translation_time": 2.31
}

Étape 1: Soumettre le lot

curl -X POST https://api.translateapi.ai/api/v1/translate/batch/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "texts": ["Hello", "Goodbye", "Thank you"],
    "target_language": "es",
    "source_language": "en"
}'

Réponse (HTTP 202 acceptée)

{
    "job_id": "67535b2b-c9e3-4f82-9499-e237edbc1dd8",
    "status": "pending",
    "total_texts": 3,
    "queue_position": 1,
    "source_language": "en",
    "target_languages": ["es"],
    "character_count": 22,
    "credits_remaining": -1,
    "poll_url": "https://api.translateapi.ai/api/v1/jobs/67535b2b-c9e3-4f82-9499-e237edbc1dd8/"
}

Étape 2 : Sondage pour obtenir des résultats

GET https://api.translateapi.ai/api/v1/jobs/{job_id}/

Exemple de sondage (Python)

import time, requests

job_id = response.json()["job_id"]
total = response.json()["total_texts"]
headers = {"Authorization": "Bearer YOUR_API_KEY"}

print(f"Batch submitted: {total} texts (job {job_id})")

while True:
    result = requests.get(f"https://api.translateapi.ai/api/v1/jobs/{job_id}/", headers=headers).json()
    status = result["status"]
    processed = result.get("processed_texts", 0)
    progress = result.get("progress_percentage", 0)

    if status == "completed":
        print(f"Completed: {processed}/{total} texts in {result.get('processing_time', 0):.1f}s")
        translations = result["result_data"]["translations"]
        break
    elif status == "failed":
        print(f"Failed at {processed}/{total}: {result.get('error_message', 'unknown')}")
        raise Exception(result.get("error_message", "Translation failed"))
    elif status == "pending":
        queue_pos = result.get("queue_position", "?")
        print(f"Queued (position {queue_pos}) — waiting for GPU worker...")
    else:
        print(f"[{status}] {processed}/{total} ({progress:.0f}%)")

    time.sleep(3)

Réponse (en attente — en attente, en attente du GPU)

{
    "job_id": "67535b2b-...",
    "status": "pending",
    "processed_texts": 0,
    "total_texts": 3,
    "progress_percentage": 0.0,
    "queue_position": 3
}

Réponse (en cours de traitement)

{
    "job_id": "67535b2b-...",
    "status": "processing",
    "processed_texts": 1,
    "total_texts": 3,
    "progress_percentage": 33.33,
    "queue_position": null
}

Réponse (achevée)

{
    "job_id": "67535b2b-...",
    "status": "completed",
    "processed_texts": 3,
    "total_texts": 3,
    "progress_percentage": 100.0,
    "processing_time": 10.65,
    "result_data": {
        "translations": ["Hola", "Adiós", "Gracias"],
        "source_language": "en",
        "target_language": "es",
        "character_count": 22,
        "processing_time": 10.65
    }
}

Suivi des progrès en temps réel

Chaque réponse au sondage comprend des champs de progression en temps réel afin que vous puissiez surveiller exactement ce qui se passe avec votre lot:

Meilleures pratiques pour les grandes charges de travail

• Envoyer 1 langue cible par demande de lot. Cela maintient chaque lot rapidement et rend les progrès faciles à suivre.
• Conservez les lots à 50-100 textes. Les petits lots se terminent plus rapidement et vous donnent des mises à jour plus fréquentes.
• Exécutez au plus 2 tâches simultanées de batch. Le GPU traite 2 lots en parallèle — des tâches supplémentaires file d'attente et ne démarrera pas plus rapidement.
• Au moment de l'arrêt, revérifier le même job_id au lieu de soumettre un nouveau lot. La tâche originale peut encore être de traiter sur le GPU.
• Sondage toutes les 3-5 secondes. Le vote plus fréquent n'accélère pas le traitement.

Lot multi-langues

Traduire plusieurs textes en plusieurs langues à la fois:

{
    "texts": ["Hello", "Goodbye"],
    "target_languages": ["es", "fr"],
    "source_language": "en"
}

_Données de résultat complétées

{
    "translations": [
        {"es": "Hola", "fr": "Bonjour"},
        {"es": "Adiós", "fr": "Au revoir"}
    ],
    "source_language": "en",
    "target_languages": ["es", "fr"],
    "character_count": 24,
    "processing_time": 2.45
}

Paramètres de demande

* Fournissez l'une ou l'autre target_language ou target_languages, pas les deux.

Demande (multiparte/forme-données)

Types de fichiers pris en charge

Exemple (cURL)

# Translate a Word document
curl -X POST https://api.translateapi.ai/api/v1/translate/document/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@document.docx" \
  -F "target_language=es" \
  -F "source_language=en"

# Translate text from an image (OCR)
curl -X POST https://api.translateapi.ai/api/v1/translate/document/ \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "file=@scanned_page.jpg" \
  -F "target_language=es" \
  -F "source_language=en"

Réponse

{
    "id": 123,
    "original_filename": "document.docx",
    "file_type": "docx",
    "source_language": "en",
    "target_language": "es",
    "status": "completed",
    "character_count": 5420,
    "translated_file_url": "/media/translated/document_es.docx",
    "created_at": "2024-01-15T10:30:00Z",
    "completed_at": "2024-01-15T10:30:05Z"
}

Valeurs de l'état

Vérifiez l'état d'une traduction de document ou récupérer l'URL de téléchargement.

Réponse

{
    "id": 123,
    "original_filename": "document.docx",
    "status": "completed",
    "translated_file_url": "/media/translated/document_es.docx",
    "character_count": 5420
}

Organe de demande

{
    "text": "Bonjour, comment allez-vous?",
    "target_language": "en"
}

Réponse

{
    "translated_text": "Hello, how are you?",
    "source_language": "fr",
    "target_language": "en",
    "translations": {
        "en": "Hello, how are you?"
    },
    "character_count": 28,
    "translation_time": 0.52
}

Les source_language champ dans la réponse montre la langue détectée lorsque la détection automatique est utilisée.

Réponse

{
    "count": 186,
    "results": [
        {"iso": "en", "name": "English", "en_label": "English"},
        {"iso": "es", "name": "Español", "en_label": "Spanish"},
        {"iso": "fr", "name": "Français", "en_label": "French"},
        ...
    ]
}