API Reference

Introduction

The Neurooo API is built on REST principles and conventions.

All requests must be made over HTTPS and most require authentication. Our API endpoints accept JSON parameters and return JSON-encoded responses.

The current version of the API is v1 and the base URL is https://neurooo.com/api/v1/.

Authentication

The Neurooo API offers three authentication methods: JSON parameter, URL query parameter, and HTTP headers.

If you use more than one authentication method for a request, the priority order is the following:

• JSON parameter
• URL query parameter
• HTTP headers

JSON parameter

Add your API key as api_key parameter in the JSON body of your request.

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

URL query parameter

Add your API key as api_key parameter in the request URL.

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

HTTP headers

Add your API key as x-api-key in the request headers.

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

Errors

Neurooo uses conventional HTTP codes to indicate if a request is successful (2xx) or if it failed (4xx). Errors will be returned in JSON format, giving you a clear indication about any missing, unauthorized or erroneous parameters.

errors is always an array of strings. If your request triggers several errors, all the errors will be returned in the response.

Example

{
  "source": 42
}

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

API endpoints

The Neurooo API consists of three endpoints:

• /translate
• /detect_language
• /languages

Translate

The /translate endpoint allows you to translate text from one language to another. It accepts a number of optional parameters.

Parameters

Response

Examples

Translate text from English into Spanish.

In this example, we use only required parameters.

{
  "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"
}

Translate using a specific engine

In this example, we use the optional engine parameter, in addition to the required ones.

{
  "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"
}

Translate with a formal tone

In this example, we use the optional tone parameter in addition to the required ones.

{
  "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"
}

Translate the same text with different contexts

In these examples, we use the optional context and source_language_code parameters, in addition to the required ones.

{
  "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"
}

Translate HTML content

In this example, we use the optional format parameter in addition to the required ones.

{
  "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 propulse le progrès, inspirant des solutions révolutionnaires et transformant les industries. Explorez les tendances clés qui façonnent demain...</p></article>",
  "source_language_code": "en"
}

Detect language

The /detect_language endpoint allows to detect the language of a text.

Parameters

Response

Examples

Detect the language of a text

In this example, we use only the required source parameter.

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

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

Detect the language of a text, but detection is uncertain

In this example, we use only the required source parameter.

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

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

Languages

The /languages endpoint returns the list of languages that you can use as source and target languages in your requests to our /translate endpoint.

Parameters

Response

This endpoint responds with an array of languages based on this list.

Each language has the following structure:

Examples

Retrieve the basic list

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"
  },
  ...
]

Retrieve the full list

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)‎"
  },
  ...
]