Translation Service API Documentation

Overview

This documentation aims to provide all necessary guidance and details for integrating with our Translation Service API from the requester's end. The core engine is OpenAI LM gpt-4-0125-preview with temperature 0.2. This translation Service API supports translations to both German (DE) and French (FR) languages. The service is designed to offer translations for predefined sets of phrases.

Service Endpoints

• URL: https://api.exponode.com/en-to-eu_server.php
  • Note: The URL provided is for testing purposes as of April 2024.

Supported Languages

• German (DE)
• French (FR)

Request Parameters

To request a translation, your system needs to send a POST request to our service endpoint with the following parameters:

• text (required): The text string you wish to translate, with or without html tags, the text format and structure will not be altered. i.e. all html tags will remain unchanged after translation.
• lang (required): The target language for the translation. Use "DE" for German and "FR" for French.

Sample Request

Below is a PHP script example demonstrating how to send a translation request using cURL:

<?php

// The data to be translated and the target language
$content = "html or plain text content here";
$targetLanguage = "German"; // or French
$data = ['text' => $content, 'lang' => $targetLanguage];
// Example below
$data = ['text' => 'Hello', 'lang' => 'FR'];

// Initialize CURL session
$ch = curl_init();

// Set CURL options
curl_setopt($ch, CURLOPT_URL, "https://api.exponode.com/en-to-eu_server.php");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

// Execute CURL session and capture the response
$response = curl_exec($ch);

// Close CURL session
curl_close($ch);

// Display the response
echo "Translated text: " . $response;

?>
    

Response

The response to your request will be a plain text string of the translated text. If the requested text or language is not provided or if the text cannot be found in our database, you will receive an error message.

Error Handling

In case of missing text or language parameters, the API will return:

• No text or language provided

If the text is not available for translation in the requested language:

• Translation not found

Enhanced error management and handshake protocols will be integrated in subsequent updates to ensure robust, seamless interaction and connectivity. At times, OpenAI's LM may generate whimsical or unwanted content. To address this, we can implement stricter guidelines to either mitigate or eliminate such occurrences. However, this adjustment necessitates input from the requester's side.

Security and Authentication

This version of the API does not require authentication. However, it is recommended to implement standard security measures such as HTTPS for data encryption during transit.

Rate Limiting

Please note that the current version of the API does not enforce rate limiting. Kiteworks is currently covering the cost for OpenAI tokens.

Support & Questions

Please contact web@kiteworks.com.

---

Updated 04/29/2024.