logitalk API Dokumentáció

A logitalk egy professzionális magyar szövegfelolvasó (TTS) API, amely valódi magyar hangszínésszel tanított modellt használ. Elérhető felhőben (talk.loginet.com) és On-Premise környezetben is.

Fontos: Az API használatához regisztráció és API kulcs szükséges. Regisztrálj itt.

Gyors kezdés

1. API kulcs beszerzése

Regisztrálj a belépési oldalon, majd a dashboardon generálj egy API kulcsot.

2. Első kérés küldése

Példa egy egyszerű cURL kérésre:

3. Válasz feldolgozása

A válasz egy JSON objektum, amely tartalmazza a generált hangfájl URL-jét:

{
  "audio_url": "/v1/audio/tts_xyz123.wav"
}

Authentikáció

Minden API kérés Bearer token authentikációt igényel. Az API kulcsodat az Authorization headerben vagy x-api-key headerben kell elküldened:

Authorization: Bearer YOUR_API_KEY
# vagy
x-api-key: YOUR_API_KEY

Figyelem: Ne osszd meg az API kulcsodat senkivel és ne commitáld verziókezelőbe!

REST API

POST /v1/text-to-speech

Szöveg átalakítása beszéddé. A válasz egy JSON objektum, amely tartalmazza a generált audio URL-jét.

Request Body

{
  "text": "string"  // Max 5000 karakter
}

Response

{
  "audio_url": "/v1/audio/tts_xyz123.wav"
}

Fájl feltöltés API

POST /api/files/upload

Dokumentumok (DOCX, PPTX) feltöltése feldolgozásra és TTS generálásra. A fájl szövege automatikusan kivonásra kerül és hang generálódik belőle.

Request Headers

Content-Type: multipart/form-data
x-api-key: YOUR_API_KEY

Parameters

file: File  // DOCX vagy PPTX, max 10MB

Response

{
  "success": true,
  "fileId": "507f1f77bcf86cd799439011",
  "filename": "document.docx",
  "characterCount": 1250,
  "estimatedCost": 1250,
  "status": "pending",
  "message": "File uploaded successfully and queued for processing"
}

cURL Példa

curl -X POST "https://yourdomain.com/api/files/upload" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@/path/to/document.docx"

Fonéma API

A Fonéma API lehetővé teszi, hogy workspace szinten testreszabhasd bizonyos szavak vagy kifejezések kiejtését. Különösen hasznos szakszavak, márknevek vagy idegen nevek esetén.

GET /api/workspace/phonemes

Listázza az összes fonéma szabályt a workspace-ben.

Response

{
  "success": true,
  "phonemeRules": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "expression": "GitHub",
      "phoneme": "gíthab",
      "createdAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}

POST /api/workspace/phonemes

Új fonéma szabály létrehozása.

Request Body

{
  "expression": "GitHub",  // A keresendő szó/kifejezés
  "phoneme": "gíthab"     // Hogyan ejtse ki
}

cURL Példa

curl -X POST "https://yourdomain.com/api/workspace/phonemes" \
  -H "Content-Type: application/json" \
  -H "x-api-key: YOUR_API_KEY" \
  -d '{"expression": "GitHub", "phoneme": "gíthab"}'

PUT /api/workspace/phonemes/:id

Meglévő fonéma szabály módosítása.

DELETE /api/workspace/phonemes/:id

Fonéma szabály törlése.

POST /api/workspace/phonemes/import

Tömeges importálás CSV vagy XLSX fájlból.

CSV Formátum

expression,phoneme
GitHub,gíthab
API,á pé í
MongoDB,mongo dí bí

cURL Példa

curl -X POST "https://yourdomain.com/api/workspace/phonemes/import" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@/path/to/phonemes.csv" \
  -F "overwriteConflicts=true"

WebSocket API

A WebSocket API lehetővé teszi a valós idejű streaming beszédgenerálást. Ideális hosszabb szövegek esetén, ahol folyamatos visszajelzésre van szükség.

Kapcsolódás

wss://talk.loginet.com/v1/text-to-speech/stream

Üzenet formátum

{
  "action": "start",
  "text": "A felolvasandó szöveg...",
  "api_key": "YOUR_API_KEY"
}

Mikor melyiket használd?

REST API

✓Rövid szövegek (max 5000 karakter)
✓Egyszerű integráció
✓Batch feldolgozás

WebSocket API

✓Hosszú szövegek
✓Valós idejű streaming
✓Folyamatos visszajelzés szükséges

Hibakezelés

Státusz kód	Jelentés	Megoldás
200	Sikeres kérés	-
400	Hibás kérés	Ellenőrizd a request body formátumát
401	Authentikációs hiba	Ellenőrizd az API kulcsodat
429	Rate limit	Várj néhány másodpercet
500	Szerver hiba	Próbáld újra később vagy írj nekünk

Limitek és kvóták

Maximális szöveg hossz (REST)5000 karakter

Rate limit (Starter)10 req/min

Rate limit (Professional)100 req/min

Rate limit (Business)1000 req/min

Tipp: Ha magasabb limitre van szükséged, lépj kapcsolatba velünk az Enterprise csomagért.

Kérdésed van?

Ha bármilyen kérdésed van az API-val kapcsolatban, vedd fel velünk a kapcsolatot!

Kapcsolatfelvétel

REST API Példa

curl -X POST "https://talk.loginet.com/v1/text-to-speech" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text": "Helló világ!"}' \
  --output speech.wav

WebSocket Példa

const ws = new WebSocket(
  'wss://talk.loginet.com/v1/text-to-speech/stream'
);

ws.onopen = () => {
  ws.send(JSON.stringify({
    action: 'start',
    text: 'Hosszú szöveg...',
    api_key: apiKey
  }));
};

ws.onmessage = (event) => {
  // Audio chunks folyamatos fogadása
  const data = JSON.parse(event.data);
};