Create Document Translation

Create a new translation for a document.

POST /api/v1/documents/{document_id}/translations

Create Document Translation

cURL

curl --request POST \
  --url https://{tenant_id}.api.useago.com/api/v1/documents/{document_id}/translations \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "language": "<string>",
  "title": "<string>",
  "content": "<string>",
  "related_questions": "<string>"
}
'

import requests

url = "https://{tenant_id}.api.useago.com/api/v1/documents/{document_id}/translations"

payload = {
    "language": "<string>",
    "title": "<string>",
    "content": "<string>",
    "related_questions": "<string>"
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    language: '<string>',
    title: '<string>',
    content: '<string>',
    related_questions: '<string>'
  })
};

fetch('https://{tenant_id}.api.useago.com/api/v1/documents/{document_id}/translations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

201

{
  "id": "<string>",
  "language": "<string>",
  "title": "<string>",
  "content": "<string>",
  "object": "translation",
  "related_questions": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key · string · header · required

Path Parameters

document_id · string · required

Body

application/json

Schema for creating a translation.

language · string · required

title · string · required

content · string · required

related_questions · string | null

Response

201 - application/json

Created

Schema for a document translation.

id · string · required

language · string · required

title · string · required

content · string · required

object · string · default: translation

related_questions · string | null

created_at · string<date-time> | null

updated_at · string<date-time> | null