Komme i gang

Bruk PolyLingo HTTP API for å oversette ren tekst, Markdown, JSON eller HTML samtidig som strukturen beholdes. Denne guiden dekker produksjonsendepunktet, autentisering og din første vellykkede forespørsel.

Grunnleggende URL

Alle eksempler bruker produksjons-API-en:

URL
Produksjonhttps://api.usepolylingo.com/v1

Hver sti nedenfor er relativ til denne basen (for eksempel betyr POST /translate POST https://api.usepolylingo.com/v1/translate).

Hvis du kjører din egen PolyLingo API-instans, erstatt verten med din distribusjons-URL og behold /v1-prefikset med mindre du har konfigurert det annerledes.

Autentisering

Beskyttede endepunkter forventer API-nøkkelen din i Authorization-headeren:

Authorization: Bearer <your_api_key>

Få en nøkkel: Opprett en i PolyLingo-appen under API keys. Du ser hele nøkkelen bare én gang—lagre den et trygt sted (miljøvariabel eller hemmelighetsbehandler). Nøkler kan tilbakekalles fra samme skjerm.

Sikkerhet: Behandle nøkkelen som et passord. Foretrekk å kalle API-en fra din server, ikke fra offentlig nettleserkode, slik at nøkkelen aldri eksponeres for brukere.

Hvis headeren mangler, er feil, eller nøkkelen er ugyldig eller tilbakekalt, svarer API-en med 401 og error: "invalid_api_key".

Endepunkter og nøkler

Ingen nøkkel krevesGET /health — rask oppetidssjekk
GET /languages — støttede språkkoder
Nøkkel krevesPOST /translate — oversett innhold
POST /translate/batch — oversett flere elementer
POST /jobs — sett i kø for langvarig oversettelse (returnerer 202 umiddelbart)
GET /jobs/:id — sjekk jobbstatus; inkluderer queue_position mens du venter
GET /usage — bruk for den autentiserte kontoen

Første forespørsel (cURL)

export POLYLINGO_API_KEY="pl_your_key_here"

curl -sS -X POST "https://api.usepolylingo.com/v1/translate" \
  -H "Authorization: Bearer $POLYLINGO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "content": "# Hello\n\nThis is **bold**.",
    "format": "markdown",
    "targets": ["es", "fr"],
    "model": "standard"
  }'

Et vellykket svar inkluderer et translations-objekt (én oppføring per målspråk du ba om) og et usage-objekt med token-tellinger.

Første forespørsel (Node.js)

Node.js 18+ inkluderer fetch:

const API_KEY = process.env.POLYLINGO_API_KEY
const res = await fetch('https://api.usepolylingo.com/v1/translate', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    Authorization: `Bearer ${API_KEY}`,
  },
  body: JSON.stringify({
    content: '# Hello\n\n**Bold** text.',
    format: 'markdown',
    targets: ['de', 'ja'],
    model: 'standard',
  }),
})
const data = await res.json()
if (!res.ok) throw new Error(`${data.error}: ${data.message}`)
console.log(data.translations)

Sjekk at API-en er tilgjengelig

Ingen nøkkel trengs for helse:

curl -sS "https://api.usepolylingo.com/v1/health"

Du bør se en liten JSON-payload som indikerer at tjenesten er oppe. Bruk GET /languages for listen over koder du kan sende som targets.

CORS og nettleserapper

API-en kan begrense hvilke nettleseropprinnelser som kan kalle den direkte, slik at nøkler ikke brukes fra upålitelige nettsteder. Server-side kall (Node, Python, edge-funksjoner, backend) er ikke begrenset av CORS.

For en single-page app er det vanlige mønsteret: frontend-en din kommuniserer med backend-en din, og backend-en kaller PolyLingo med API-nøkkelen.

Neste steg

  • API-referanse — forespørsels- og responsformer, formater, feil og begrensninger.
Kom i gang | PolyLingo | PolyLingo