API reference

Dette dokument matcher adfærden af Express appen i api/app.js og rutehåndtererne under api/routes/.

Grænser og adfærd

Månedligt token-tillæg (gratis niveau): Før kald til modellen estimerer API tokens cirka som ceil(content_length / 4) × (number_of_targets + 1) og for free niveauet alene afviser anmodningen med 429 / token_limit_reached, hvis estimatet overstiger den resterende månedlige tildeling (FREE_TIER_MONTHLY_TOKENS, standard 100000). Betalte niveauer blokeres ikke af denne forudgående kontrol i enforceTokenCap; brugen logges stadig.

Rate limits: Når Upstash Redis er konfigureret (UPSTASH_REDIS_REST_URL / UPSTASH_REDIS_REST_TOKEN, og URL indeholder ikke pladsholderen your-instance), gælder minutgrænser efter niveau: free 5, starter 30, growth 60, scale 120, enterprise ubegrænset. Ved grænseoverskridelse er svaret 429 med error: "rate_limit_reached". Hvis Redis ikke er konfigureret, springes ratebegrænsning over (se rateLimit.js).

Succesfulde ratebegrænsede svar kan inkludere X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

GET /health

Ingen autentifikation.

Respons 200

{
  "status": "ok",
  "timestamp": "2025-03-23T12:00:00.000Z"
}

GET /languages

Ingen autentifikation.

Returnerer den kanoniske liste over understøttede sprog (kode, visningsnavn, RTL-flag). Der er 36 poster; koder er de eneste værdier, der accepteres i targets på oversættelsesendepunkter.

Respons 200

{
  "languages": [
    { "code": "en", "name": "English", "rtl": false },
    { "code": "ar", "name": "Arabic", "rtl": true }
  ]
}

Kilde: api/utils/languages.js.

POST /translate

Kræver Authorization: Bearer <api_key>.

Oversætter en enkelt content streng til hvert sprog angivet i targets. Modellen returnerer et enkelt JSON-objekt, hvis nøgler er præcis de ønskede sprogkoder, og hvis værdier er oversatte strenge (se formatPrompts.js).

Anmodningsbody

Respons 200

{
  "translations": {
    "es": "...",
    "fr": "..."
  },
  "usage": {
    "input_tokens": 120,
    "output_tokens": 340,
    "total_tokens": 460,
    "model": "standard",
    "detected_format": "markdown",
    "detection_confidence": 0.95
  }
}

detected_format og detection_confidence vises kun, når format blev udeladt, og automatisk detektion kørte.

Eksempel (cURL)

curl -sS -X POST "https://api.usepolylingo.com/v1/translate" \
  -H "Authorization: Bearer $POLYLINGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "{\"title\":\"Hello\"}",
    "format": "json",
    "targets": ["fr", "de"]
  }'

Eksempel (Python 3)

pip install requests

import os, requests

url = "https://api.usepolylingo.com/v1/translate"
headers = {
    "Authorization": f"Bearer {os.environ['POLYLINGO_API_KEY']}",
    "Content-Type": "application/json",
}
r = requests.post(url, json={
    "content": "<p>Hello <strong>world</strong></p>",
    "format": "html",
    "targets": ["es"],
}, timeout=120)
r.raise_for_status()
print(r.json()["translations"]["es"])

POST /translate/batch

Kræver Authorization: Bearer <api_key>.

Behandler hvert element sekventielt (et modelkald pr. element). Hvis et element fejler, returnerer API 500 og returnerer ikke delvise resultater for den anmodning.

Anmodningsbody

Respons 200

{
  "results": [
    { "id": "welcome", "translations": { "fr": "...", "de": "..." } },
    { "id": "goodbye", "translations": { "fr": "...", "de": "..." } }
  ],
  "usage": {
    "total_tokens": 900,
    "input_tokens": 400,
    "output_tokens": 500,
    "model": "standard"
  }
}

Eksempel

curl -sS -X POST "https://api.usepolylingo.com/v1/translate/batch" \
  -H "Authorization: Bearer $POLYLINGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": [
      { "id": "a", "content": "Hello", "format": "plain" },
      { "id": "b", "content": "## Title", "format": "markdown" }
    ],
    "targets": ["es", "it"]
  }'

POST /jobs

Kræver Authorization: Bearer <api_key>.

Sætter en oversættelsesjob i kø og returnerer straks med et job_id. Oversættelsen kører i baggrunden — ingen risiko for HTTP timeout uanset indholdets størrelse. Poll GET /jobs/:id for resultatet.

Brug dette endpoint i stedet for POST /translate ved oversættelse af store dokumenter (lang Markdown, mange mål-sprog), hvor anmodningens varighed kan overstige din HTTP-klients eller proxyens timeout.

Anmodningsbody

Respons 202

{
  "job_id": "a1b2c3d4-...",
  "status": "pending",
  "created_at": "2025-03-23T12:00:00.000Z"
}

GET /jobs/:id

Kræver Authorization: Bearer <api_key>.

Poller status for et job indsendt via POST /jobs. Poll hvert 5–10 sekund. Jobs ejes af den indsendende bruger — andre brugere får 404.

Respons (afventer / behandler)

{
  "job_id": "a1b2c3d4-...",
  "status": "pending",
  "created_at": "2025-03-23T12:00:00.000Z",
  "updated_at": "2025-03-23T12:00:00.000Z",
  "completed_at": null,
  "queue_position": 3
}

status er pending (venter på en worker) eller processing (worker har overtaget). queue_position (1-baseret) angiver, hvor mange ventende eller behandlede jobs der blev oprettet strengt før dette — brug det til progress UI. Udeladt hvis tælleforespørgslen fejler.

Respons (fuldført)

{
  "job_id": "a1b2c3d4-...",
  "status": "completed",
  "created_at": "2025-03-23T12:00:00.000Z",
  "updated_at": "2025-03-23T12:00:02.000Z",
  "completed_at": "2025-03-23T12:00:02.000Z",
  "translations": {
    "es": "...",
    "fr": "..."
  },
  "usage": {
    "input_tokens": 120,
    "output_tokens": 340,
    "total_tokens": 460,
    "model": "standard"
  }
}

Respons (fejlet)

{
  "job_id": "a1b2c3d4-...",
  "status": "failed",
  "error": "Model returned invalid JSON"
}

Eksempel (JavaScript)

const API = 'https://api.usepolylingo.com/v1'
const headers = {
  'Authorization': `Bearer ${process.env.POLYLINGO_API_KEY}`,
  'Content-Type': 'application/json',
}

// 1. Indsend
const submit = await fetch(`${API}/jobs`, {
  method: 'POST',
  headers,
  body: JSON.stringify({ content: longMarkdown, format: 'markdown', targets: ['de', 'fr'] }),
})
const { job_id } = await submit.json()

// 2. Poll
while (true) {
  await new Promise(r => setTimeout(r, 10_000))
  const poll = await fetch(`${API}/jobs/${job_id}`, { headers })
  const job = await poll.json()
  if (job.status === 'completed') { console.log(job.translations); break }
  if (job.status === 'failed')    { throw new Error(job.error) }
  // Valgfrit: vis fremdrift (queue_position er 1-baseret, udeladt når ikke i kø)
  if (job.queue_position != null) console.log(`Queue position: ${job.queue_position}`)
}

GET /usage

Kræver Authorization: Bearer <api_key> (standard nøgleopslag — ikke den interne bypass-only sti).

Returnerer tokenbrug for den nuværende kalender måned for den autentificerede bruger.

Respons 200

{
  "period_start": "2025-03-01T00:00:00.000Z",
  "period_end": "2025-03-31T23:59:59.000Z",
  "tokens_used": 12000,
  "tokens_included": 100000,
  "tokens_remaining": 88000,
  "overage_tokens": 0,
  "tier": "free"
}

tokens_included og tokens_remaining er null for enterprise (ubegrænset tildeling i rapportering).

Indholdsformater

Understøttede format værdier: plain, markdown, json, html.

RTL og retning i din app

For plain og markdown output returnerer API kun oversat tekst — det tilføjer ikke dir="rtl" eller wrapper-elementer. Sæt tekstretning i dit UI (CSS direction, en overordnet elements dir attribut eller dit frameworks i18n layout) når du viser arabisk, hebraisk eller persisk.

For html format kan oversat markup inkludere dir="rtl" hvor det er passende for RTL mål; se formatPrompts.js og HTML tests i scripts/test-translation.js.

Fejlsvar

Fejl er JSON når muligt:

{
  "error": "invalid_request",
  "message": "Menneskelæselig detalje"
}

GET /usage kan returnere 500 med en generisk besked, hvis Supabase forespørgsel fejler.

Underliggende modeller (informationsmæssigt)

API eksponerer kun standard og advanced. Faktiske OpenAI model IDs er konfigureret i api/utils/modelRouter.js og returneres ikke i API svar.