Référence API

Introduction

L’API de Neurooo est construite sur les principes et conventions REST.

Toutes les requêtes doivent être effectuées via HTTPS et nécessitent généralement une authentification. Les endpoints de notre API acceptent des paramètres JSON et retournent des réponses au format JSON.

La version actuelle de l’API est v1 et l’URL de base est https://neurooo.com/api/v1/.

Authentification

L'API de Neurooo propose trois méthodes d'authentification : paramètre JSON, paramètre de requête URL et en-têtes HTTP.

Si vous utilisez plus d'une méthode d'authentification pour une même requête, l'ordre de priorité sera le suivant :

• Paramètre JSON
• Paramètre de requête URL
• En-têtes HTTP

Paramètre JSON

Ajoutez votre clé API en tant que paramètre api_key dans le corps JSON de votre requête.

curl -X POST https://neurooo.com/api/v1/translate \
  -H 'Content-Type: application/json' \
  -d '{
        "api_key": "YOUR_API_KEY"
      }'

Paramètre de requête URL

Ajoutez votre clé API en tant que paramètre api_key dans l'URL de la requête.

curl -X POST https://neurooo.com/api/v1/translate?api_key=YOUR_API_KEY

En-têtes HTTP

Ajoutez votre clé API en tant que x-api-key dans les en-têtes de la requête.

curl -X POST https://neurooo.com/api/v1/translate \
  -H 'x-api-key: YOUR_API_KEY'

Erreurs

Neurooo utilise des codes HTTP conventionnels pour indiquer si une requête a été exécutée avec succès (2xx) ou si elle a échoué (4xx). Les erreurs seront renvoyées au format JSON, vous donnant une indication claire concernant tout paramètre manquant, non autorisé ou erroné.

errors est toujours un tableau de chaînes. Si votre requête déclenche plusieurs erreurs, toutes les erreurs seront retournées dans la réponse.

Exemple

{
  "source": 42
}

{
  "errors": [
    "Missing parameter: target_language_code.",
    "The 'source' parameter must be a string."
  ]
}

Endpoints de l'API

L'API de Neurooo comporte trois endpoints :

• /translate
• /detect_language
• /languages

Translate

L'endpoint /translate vous permet de traduire du texte d'une langue à une autre. Il accepte plusieurs paramètres optionnels.

Paramètres

Réponse

Exemples

Traduire un texte de l'anglais vers l'espagnol.

Dans cet exemple, nous utilisons uniquement les paramètres obligatoires.

{
  "source": "Hello everyone, and welcome to our meeting!",
  "target_language_code": "es"
}

{
  "target": "¡Hola a todos y bienvenidos a nuestra reunión!",
  "source_language_code": "en"
}

Traduire en utilisant un moteur spécifique

Dans cet exemple, nous utilisons le paramètre optionnel engine, en plus des paramètres obligatoires.

{
  "source": "We love trying different translation engines.",
  "target_language_code": "fr",
  "engine": "openai-4omini-eu"
}

{
  "target": "Nous aimons essayer différents moteurs de traduction.",
  "source_language_code": "en"
}

Traduire avec un ton formel

Dans cet exemple, nous utilisons le paramètre optionnel tone en plus des paramètres obligatoires.

{
  "source": "I'm glad you could attend the meeting.",
  "target_language_code": "fr",
  "source_language_code": "en",
  "tone": "formal"
}

{
  "target": "Je suis ravi que vous ayez pu assister à la réunion.",
  "source_language_code": "en"
}

Traduire le même texte avec différents contextes

Dans ces exemples, nous utilisons les paramètres optionnels context et source_language_code, en plus des paramètres obligatoires.

{
  "source": "Could you send me a photo of the damaged washer?",
  "target_language_code": "fr",
  "source_language_code": "en",
  "context": "online shop selling mechanical pieces"
}

{
  "target": "Pourriez-vous m'envoyer une photo de la rondelle endommagée ?",
  "source_language_code": "en"
}

{
  "source": "Could you send me a photo of the damaged washer?",
  "target_language_code": "fr",
  "source_language_code": "en",
  "context": "online shop selling house appliances"
}

{
  "target": "Pourriez-vous m'envoyer une photo du lave-linge endommagé ?",
  "source_language_code": "en"
}

Traduire du contenu HTML

Dans cet exemple, nous utilisons le paramètre optionnel format en plus des paramètres obligatoires.

{
  "source": "<article class=\"blog-post\"><h2 class=\"post-title\">Embracing Innovation: Shaping the Future</h2><p class=\"post-meta\">Published on <time datetime=\"2024-12-27\">December 27, 2024</time></p><p class=\"post-excerpt\">Innovation drives progress, inspiring groundbreaking solutions and transforming industries. Explore the key trends shaping tomorrow...</p></article>",
  "target_language_code": "fr",
  "format": "html"
}

{
  "target": "<article class=\"blog-post\"><h2 class=\"post-title\">Adopter l'innovation : façonner l'avenir</h2><p class=\"post-meta\">Publié le <time datetime=\"2024-12-27\">27 décembre 2024</time></p><p class=\"post-excerpt\">L'innovation stimule le progrès, inspire des solutions révolutionnaires et transforme les industries. Explorez les principales tendances qui façonnent demain...</p></article>",
  "source_language_code": "en"
}

Detect language

L'endpoint /detect_language permet de détecter la langue d'un texte.

Paramètres

Réponse

Exemples

Détecter la langue d'un texte

Dans cet exemple, nous utilisons uniquement le paramètre obligatoire source.

{
  "source": "Geweldig product! Hoge kwaliteit, betaalbare prijs en snelle levering."
}

{
  "code": "nl",
  "name": "Dutch"
}

Détecter la langue d'un texte, mais la détection est incertaine

Dans cet exemple, nous utilisons uniquement le paramètre obligatoire source.

{
  "source": "Why esperar mañana quand on peut jetzt vivre la dolce vita?"
}

{
  "code": "",
  "name": "Uncertain"
}

Languages

L'endpoint /languages retourne la liste des langues que vous pouvez utiliser comme langues sources et cibles dans vos requêtes à l'endpoint /translate.

Paramètres

Réponse

Cet endpoint retourne un tableau de langues basé sur notre liste.

Chaque langue a la structure suivante:

Exemples

Récupérer la liste de base

curl -X GET https://neurooo.com/api/v1/languages

[
  {
    "code": "af",
    "name": "Afrikaans"
  },
  {
    "code": "ak",
    "name": "Akan"
  },
  {
    "code": "am",
    "name": "Amharic"
  },
  {
    "code": "ar",
    "name": "Arabic‎"
  },
  {
    "code": "as",
    "name": "Assamese"
  },
  {
    "code": "az",
    "name": "Azeri"
  },
  ...
]

Récupérer la liste complète

curl -X GET https://neurooo.com/api/v1/languages?full=true

[
  {
    "code": "af",
    "name": "Afrikaans"
  },
  {
    "code": "ak",
    "name": "Akan"
  },
  {
    "code": "am",
    "name": "Amharic"
  },
  {
    "code": "ar",
    "name": "Arabic‎"
  },
  {
    "code": "ar-AE",
    "name": "Arabic (U.A.E.)‎"
  },
  {
    "code": "ar-BH",
    "name": "Arabic (Bahrain)‎"
  },
  {
    "code": "ar-DZ",
    "name": "Arabic (Algeria)‎"
  },
  ...
]