Getting started

PolyLingo HTTP API का उपयोग करें ताकि सादा टेक्स्ट, Markdown, JSON, या HTML का अनुवाद करते समय संरचना को बरकरार रखा जा सके। यह गाइड प्रोडक्शन एंडपॉइंट, प्रमाणीकरण, और आपकी पहली सफल अनुरोध को कवर करता है।

Base URL

सभी उदाहरण प्रोडक्शन API का उपयोग करते हैं:

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

नीचे दिया गया हर पाथ उस बेस के सापेक्ष है (उदाहरण के लिए, POST /translate का मतलब है POST https://api.usepolylingo.com/v1/translate)।

यदि आप अपना स्वयं का PolyLingo API इंस्टेंस चला रहे हैं, तो होस्ट को अपनी डिप्लॉयमेंट URL से बदलें और /v1 प्रीफिक्स को तब तक रखें जब तक आपने अन्यथा कॉन्फ़िगर न किया हो।

Authentication

सुरक्षित एंडपॉइंट्स आपके API कुंजी को Authorization हेडर में अपेक्षित करते हैं:

Authorization: Bearer <your_api_key>

कुंजी प्राप्त करना: PolyLingo ऐप में API keys के अंतर्गत एक बनाएं। आप पूरी कुंजी केवल एक बार देखते हैं—इसे कहीं सुरक्षित रखें (पर्यावरण चर या सीक्रेट मैनेजर)। कुंजियाँ उसी स्क्रीन से रद्द की जा सकती हैं।

सुरक्षा: कुंजी को पासवर्ड की तरह व्यवहार करें। API को अपने सर्वर से कॉल करना पसंद करें, न कि सार्वजनिक ब्राउज़र कोड से, ताकि कुंजी उपयोगकर्ताओं के लिए कभी उजागर न हो।

यदि हेडर गायब है, गलत है, या कुंजी अमान्य या रद्द हो गई है, तो API 401 के साथ प्रतिक्रिया देता है और error: "invalid_api_key"।

Endpoints and keys

No key requiredGET /health — त्वरित अपटाइम जांच
GET /languages — समर्थित भाषा कोड
Key requiredPOST /translate — सामग्री का अनुवाद करें
POST /translate/batch — कई आइटम का अनुवाद करें
POST /jobs — लंबी चलने वाली अनुवाद को कतार में डालें (तुरंत 202 लौटाता है)
GET /jobs/:id — जॉब स्थिति पूछताछ; प्रतीक्षा के दौरान queue_position शामिल है
GET /usage — प्रमाणीकृत खाते के लिए उपयोग

First request (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"
  }'

सफल प्रतिक्रिया में एक translations ऑब्जेक्ट शामिल होता है (आपके अनुरोधित प्रत्येक लक्ष्य भाषा के लिए एक प्रविष्टि) और एक usage ऑब्जेक्ट जिसमें टोकन गणना होती है।

First request (Node.js)

Node.js 18+ में 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)

Check that the API is reachable

स्वास्थ्य के लिए कोई कुंजी आवश्यक नहीं है:

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

आपको एक छोटा JSON पेलोड दिखाई देगा जो सेवा के चालू होने का संकेत देता है। आप targets के रूप में पास करने के लिए कोड की सूची के लिए GET /languages का उपयोग करें।

CORS and browser apps

API यह प्रतिबंधित कर सकता है कि कौन से ब्राउज़र मूल इसे सीधे कॉल कर सकते हैं, ताकि कुंजियाँ अविश्वसनीय साइटों से उपयोग न हों। सर्वर-साइड कॉल (Node, Python, एज फ़ंक्शंस, आपका बैकएंड) CORS द्वारा सीमित नहीं हैं।

एक सिंगल-पेज ऐप के लिए, सामान्य पैटर्न है: आपका फ्रंटेंड आपके बैकएंड से बात करता है, और आपका बैकएंड API कुंजी के साथ PolyLingo को कॉल करता है।

Next steps

  • API reference — अनुरोध और प्रतिक्रिया के स्वरूप, फॉर्मेट, त्रुटियाँ, और सीमाएँ।
शुरुआत करें | PolyLingo | PolyLingo