Skip to main content
POST
/
faq-collections
/
{id}
/
translate
Translate an FAQ collection with AI
curl --request POST \
  --url https://api.nateq.io/api/v1/faq-collections/{id}/translate \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "targetLocale": "<string>"
}
'
import requests

url = "https://api.nateq.io/api/v1/faq-collections/{id}/translate"

payload = { "targetLocale": "<string>" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetLocale: '<string>'})
};

fetch('https://api.nateq.io/api/v1/faq-collections/{id}/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.nateq.io/api/v1/faq-collections/{id}/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([
'targetLocale' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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.nateq.io/api/v1/faq-collections/{id}/translate"

payload := strings.NewReader("{\n \"targetLocale\": \"<string>\"\n}")

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

req.Header.Add("Authorization", "<api-key>")
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.nateq.io/api/v1/faq-collections/{id}/translate")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetLocale\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.nateq.io/api/v1/faq-collections/{id}/translate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetLocale\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "color": "<string>",
    "createdAt": "<string>",
    "description": "<string>",
    "displayOrder": 123,
    "faqCount": 123,
    "faqs": [
      {
        "category": {
          "collectionId": "<string>",
          "createdAt": "<string>",
          "displayOrder": 123,
          "id": "<string>",
          "name": "<string>",
          "organizationId": "<string>",
          "updatedAt": "<string>"
        },
        "categoryId": "<string>",
        "collection": "<unknown>",
        "collectionId": "<string>",
        "content": "<string>",
        "createdAt": "<string>",
        "description": "<string>",
        "displayOrder": 123,
        "id": "<string>",
        "isFeatured": true,
        "isPublished": true,
        "locale": "<string>",
        "organizationId": "<string>",
        "readTime": 123,
        "slug": "<string>",
        "tags": [
          "<string>"
        ],
        "title": "<string>",
        "updatedAt": "<string>",
        "views": 123
      }
    ],
    "icon": "<string>",
    "id": "<string>",
    "isPublished": true,
    "locale": "<string>",
    "name": "<string>",
    "organizationId": "<string>",
    "slug": "<string>",
    "totalReadTime": 123,
    "updatedAt": "<string>"
  },
  "error": {
    "code": "<string>",
    "details": "<unknown>",
    "message": "<string>"
  },
  "message": "<string>",
  "meta": {
    "aiTranslation": "<string>",
    "count": 123,
    "endCursor": "<string>",
    "hasNext": true,
    "hasPrevious": true,
    "limit": 123,
    "page": 123,
    "pageSize": 123,
    "pendingCount": 123,
    "routingCapability": "<string>",
    "startCursor": "<string>",
    "total": 123,
    "totalPages": 123
  },
  "success": true
}

Authorizations

Authorization
string
header
required

Your API key as a Bearer token: Authorization: Bearer tg_live_...

Path Parameters

id
string
required

Source collection ID

Body

application/json

Target locale

targetLocale
string
required
Required string length: 2 - 10

Response

201 - application/json

Created

data
object
error
object
message
string
meta
object
success
boolean