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 teljes URL-jét:

{
  "success": true,
  "audioUrl": "https://cdn.loginet.com/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

A válasz application/json, nem bináris audio. Az audioUrl egy közvetlenül letölthető, teljes URL.

{
  "success": true,
  "audioUrl": "https://cdn.loginet.com/audio/tts_xyz123.wav",  // WAV (elsődleges)
  "wavUrl": "https://cdn.loginet.com/audio/tts_xyz123.wav",
  "mp3Url": "https://cdn.loginet.com/audio/tts_xyz123.mp3",
  "duration": 3.2,          // másodperc
  "characterCount": 12,
  "cost": 12,              // levont kredit (cache találat esetén 0)
  "fromCache": false,
  "remainingCredits": 98765
}

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://talk.loginet.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://talk.loginet.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://talk.loginet.com/api/workspace/phonemes/import" \
  -H "x-api-key: YOUR_API_KEY" \
  -F "file=@/path/to/phonemes.csv" \
  -F "overwriteConflicts=true"

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
402	Nincs elég kredit	Tölts fel krediteket a dashboardon
429	Rate limit	Várj néhány másodpercet
500	Szerver hiba	Próbáld újra később vagy írj nekünk
502	A háttérszolgáltatás nem elérhető	Átmeneti üzemzavar, próbáld újra pár perc múlva

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!"}'

# A válasz JSON. A hangfájl letöltése az "audioUrl" alapján:
curl -O "$AUDIO_URL"