Intelligence

Translate workspace text

Looks up a tenant-scoped translation by normalized text and target language, or generates and caches one. Successful output returns only the translated text and cache indicator. The organization is derived from the authenticated user. Requires permission: one of groups, admins, new_form, forms, manage_programs, donors_manage, donations, manage_email, email_manager, manage_sms, sms_manager, sms_inbox_view, sms_inbox_reply, sms_inbox_manage, sendblue_manage, mailings_view, mailings_generate, mailings_manage, manage_settings, access_account_settings, access_payment_gateways, tasks_manage, trips_manage, events_manage, events_sponsor_manage, imports_manage, households_manage, notes_manage, reports_manage.

POST

admin

translate

curl --request POST \
  --url https://api.gratona.com/v1/admin/translate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Thank you for your support.",
  "language": "French"
}
'

import requests

url = "https://api.gratona.com/v1/admin/translate"

payload = {
    "text": "Thank you for your support.",
    "language": "French"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: 'Thank you for your support.', language: 'French'})
};

fetch('https://api.gratona.com/v1/admin/translate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/translate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'text' => 'Thank you for your support.',
    'language' => 'French'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/translate"

	payload := strings.NewReader("{\n  \"text\": \"Thank you for your support.\",\n  \"language\": \"French\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/translate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"Thank you for your support.\",\n  \"language\": \"French\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/translate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"Thank you for your support.\",\n  \"language\": \"French\"\n}"

response = http.request(request)
puts response.read_body

{
  "translation": "Merci pour votre soutien.",
  "cached": false
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

text

string

required

Source text. Cache identity strips HTML, normalizes whitespace and lowercases the text.

Example:

"Thank you for your support."

language

string

required

Requested target language, lowercased before cache lookup.

Example:

"French"

Response

Operation result.

translation

string

Cached or newly generated translation.

Example:

"Merci pour votre soutien."

cached

boolean

Whether the translation came from the organization cache.

Example:

false

Translate workspace text

curl --request POST \
  --url https://api.gratona.com/v1/admin/translate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "Thank you for your support.",
  "language": "French"
}
'

import requests

url = "https://api.gratona.com/v1/admin/translate"

payload = {
    "text": "Thank you for your support.",
    "language": "French"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({text: 'Thank you for your support.', language: 'French'})
};

fetch('https://api.gratona.com/v1/admin/translate', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.gratona.com/v1/admin/translate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'text' => 'Thank you for your support.',
    'language' => 'French'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.gratona.com/v1/admin/translate"

	payload := strings.NewReader("{\n  \"text\": \"Thank you for your support.\",\n  \"language\": \"French\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.gratona.com/v1/admin/translate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"text\": \"Thank you for your support.\",\n  \"language\": \"French\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/translate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"text\": \"Thank you for your support.\",\n  \"language\": \"French\"\n}"

response = http.request(request)
puts response.read_body

{
  "translation": "Merci pour votre soutien.",
  "cached": false
}

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}