Um endpoint de tradução que nunca sai da sua máquina.

Visão geral

Ative a Local API nas configurações do PrivyTranslate. O serviço então escuta apenas na interface de loopback — não é acessível de outra máquina, e nenhuma requisição é encaminhada a lugar nenhum.

Baixar o JSON do OpenAPI ↓

Autenticação

As configurações exibem um token de API assim que a Local API é ativada. Todos os endpoints exceto /health e /capabilities exigem esse token. Três transportes são aceitos:

• Cabeçalho X-Privy-Token — a forma principal para requisições HTTP.
• Authorization: Bearer — aceito tanto por requisições HTTP quanto pelo handshake do WebSocket.
• ?token= ou ?access_token= — parâmetros de consulta para clientes WebSocket do navegador, que não conseguem definir cabeçalhos.

Trate o token como qualquer outra credencial: ele concede tradução na sua máquina a quem quer que o tenha.

Endpoints

Traduzir

POST /translate recebe um lote de até 128 strings e devolve um resultado por item, em ordem. source assume auto por padrão; target é obrigatório.

Requisição

curl -s http://127.0.0.1:49321/v1/translate \
  -H "X-Privy-Token: $PRIVY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "source": "auto",
    "target": "zh-Hans",
    "texts": ["Could you confirm the revised delivery schedule?"],
    "mode": "paragraph",
    "format": "text",
    "options": { "engine": "auto", "sensitive": true }
  }'

mode aceita selection, paragraph, webpage, subtitle, message ou document. format aceita text, html ou markdown. Dentro de options, engine fixa um backend específico (local-llm, ollama, lm-studio, openai-compatible) e sensitive: true mantém a requisição fora do histórico de traduções.

Resposta

{
  "id": "tr_8F2A6D4E-5F58-4A37-8E92-7B4FD40BE2D2",
  "object": "translation",
  "created": 1755561600,
  "engine": "local-llm",
  "model": "translategemma-4b-it.Q4_K_M.gguf",
  "source": "en",
  "target": "zh-Hans",
  "results": [
    {
      "index": 0,
      "text": "能否确认修订后的交付时间表？",
      "detected_source": "en",
      "confidence": 0.98,
      "alternatives": []
    }
  ],
  "usage": { "input_chars": 48, "output_chars": 15, "latency_ms": 412 }
}

Detectar

POST /detect devolve um código de idioma e uma pontuação de confiança entre 0 e 1 para cada item, sem traduzi-lo.

curl -s http://127.0.0.1:49321/v1/detect \
  -H "Authorization: Bearer $PRIVY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "texts": ["Guten Morgen", "早上好"] }'

{
  "id": "det_8F2A6D4E-5F58-4A37-8E92-7B4FD40BE2D2",
  "object": "language_detection",
  "created": 1755561600,
  "results": [
    { "index": 0, "language": "de", "confidence": 0.97 },
    { "index": 1, "language": "zh-Hans", "confidence": 0.99 }
  ],
  "usage": { "input_chars": 16, "latency_ms": 24 }
}

WebSocket

GET /ws/translate faz upgrade para WebSocket. Cada quadro que você envia é um TranslateRequest; cada quadro que você recebe é um TranslateResponse ou um ErrorResponse. Use quando estiver traduzindo um fluxo de itens curtos e quiser evitar o custo por requisição.

const socket = new WebSocket(
  "ws://127.0.0.1:49321/v1/ws/translate?token=" + PRIVY_TOKEN
);

socket.addEventListener("open", () => {
  socket.send(JSON.stringify({
    target: "ja",
    texts: ["The quarterly invoice is attached."]
  }));
});

socket.addEventListener("message", (event) => {
  const frame = JSON.parse(event.data);
  if (frame.error) console.error(frame.error.message);
  else console.log(frame.results[0].text);
});

Limites e idiomas

GET /capabilities informa os valores em vigor; estes são os padrões.

Códigos de idioma

Os idiomas de destino usam códigos BCP 47. source aceita adicionalmente auto.

• enEnglish
• zh-Hans简体中文
• zh-Hant繁體中文
• ja日本語
• ko한국어
• frFrançais
• deDeutsch
• esEspañol
• viTiếng Việt
• thไทย
• idBahasa Indonesia
• msBahasa Melayu
• filFilipino
• myမြန်မာ
• kmខ្មែរ
• loລາວ

Erros

As falhas devolvem um único objeto error com um type estável.

{
  "error": {
    "code": "batch_too_large",
    "message": "texts exceeds max_items (128)",
    "type": "invalid_request_error",
    "param": "texts"
  }
}