GASTON REST API

OpenAPI 3.1 špecifikácia →

GASTON poskytuje jednoduché REST API, ktoré vám umožňuje prepojiť vaše aplikácie a webové stránky s našimi službami a prepisovať video a audio súbory.

Prepis súborov je asynchrónny. Po nahraní súboru do nášho API obdržíte ID, ktoré je spracovávané sekvenčne. Zvuková stopa sa extrahuje, vygeneruje sa spektrogram, deteguje sa jazyk a vykoná sa prepis. Aktuálny stav súboru, ako aj získanie prepisu a dodatočných informácií, je dostupné prostredníctvom endpointu /media. Všetky nahrané súbory sú uložené v knižnici médií, rovnako ako keby boli pridané cez webovú aplikáciu.

Autentifikácia

API kľúč musí byť súčasťou HTTP hlavičky pri každej požiadavke. Po prihlásení do vašich nastavení si vygenerujte API kľúč, ktorý sa používa na autorizáciu požiadaviek na naše REST API.

Shell 
curl -X 'GET' \
  'https://api.gaston.live/user/me' \
  -H 'accept: application/json' \
  -H 'token: gapi-1234567890'

Svoj API kľúč môžete kedykoľvek znovu vygenerovať vo vašich API nastaveniach.

Popis jednotlivých endpointov

Kompletná technická špecifikácia vo formáte OpenAPI 3.1 je dostupná tu. Nižšie je uvedený zjednodušený popis endpointov.

GET /user/me

Získa základné informácie o autentifikovanom používateľovi vrátane detailov o využívaní služby, ako je počet zostávajúcich API súborov dostupných v rámci aktuálnej kvóty.

GET /media/list

Vypíše spracované súbory uložené v knižnici médií. Odpoveď obsahuje iba súhrnné informácie a nezahŕňa celý text prepisu.

Parametre

Parameter Povinný Popis
dir_id voliteľný ID priečinka, ktorý chcete zobraziť.
page voliteľný Číslo stránky na zobrazenie. Výsledky sú stránkované po 50 záznamoch.
GET /media

Vráti kompletné informácie o súbore vrátane prepisu, časových značiek na úrovni slov a dostupných prekladov. Verziu súboru môžete filtrovať zadaním parametra lang v požiadavke. Ak je zadané lang=en a existuje anglický preklad, bude vrátený anglický prepis.

Parametre

Parameter Povinný Popis
lang voliteľný Kód jazyka na filtrovanie vrátanej verzie prepisu.
PATCH /media

Presunie mediálny súbor do vybraného priečinka.

Parametre

Parameter Povinný Popis
media_id povinný ID mediálneho súboru na presun.
dir_id povinný ID cieľového priečinka.
POZNÁMKA

Ak chcete súbor presunúť do koreňového priečinka, nechajte parameter dir_id prázdny.

POST /media/transcribe

Nahrá mediálny súbor na prepis. Maximálna veľkosť súboru je 2 GB. Môžete určiť jazyk hovorený v nahrávke. Ak nie je zadaný, jazyk bude automaticky detegovaný. Ak je známy, odporúča sa jeho zadanie pre rýchlejšie spracovanie. Môžete tiež definovať názov súboru v knižnici médií. Ak nie je zadaný, použije sa pôvodný názov súboru. Po úspešnej požiadavke endpoint odpovie detailmi o súbore vrátane jeho ID a aktuálneho stavu.

Parametre

Parameter Povinný Popis
lang voliteľný Jazyk súboru. Nechajte prázdne pre automatickú detekciu.
dir_id voliteľný ID priečinka, kam sa má súbor po prepise uložiť.
POST /media/transcribe-url

Podobne ako predchádzajúci endpoint, táto metóda prepíše video z poskytnutej URL adresy podporovanej streamovacej služby. Po odoslaní URL adresy videa sa súbor automaticky stiahne a spracuje.

Parametre

Parameter Povinný Popis
url povinný URL adresa, kde sa mediálny súbor nachádza.
lang voliteľný Jazyk súboru. Nechajte prázdne pre automatickú detekciu.
dir_id voliteľný ID priečinka, kam sa má súbor po prepise uložiť.
POST /media/translate

Preloží už prepísaný súbor do zvoleného jazyka. Momentálne je podporovaných približne 40 jazykov. Postup prekladu a dostupné jazykové verzie pre každý súbor sú uvedené v poli available_languages, kde kľúč predstavuje jazyk a hodnota predstavuje percento dokončenia.

Napríklad nasledujúci stav označuje, že súbor je úplne prepísaný v slovenčine (100 %), zatiaľ čo anglický preklad je stále vo fáze spracovania na 66 %:

available_languages: {
  sk: 100,
  en: 66
}

Parametre

Parameter Povinný Popis
media_id povinný ID mediálneho súboru na preklad.
target_lang povinný Cieľový jazyk prekladu.
PATCH /media/diarize

Spustí alebo reštartuje diarizáciu hovorcov pre mediálny súbor. Každá jazyková verzia má vlastnú segmentáciu hovorcov. Napríklad môžete mať diarizovanú anglickú verziu, zatiaľ čo španielska verzia zostane bez diarizácie.

Parametre

Parameter Povinný Popis
media_id povinný ID mediálneho súboru na diarizáciu.
lang povinný Jazyková verzia na diarizáciu.
speakers voliteľný Počet hovorcov v súbore. Nechajte prázdne pre automatickú detekciu.
GET /directory/tree

Rekurzívne vypíše celú štruktúru stromu priečinkov.

POST /directory

Vytvorí nový priečinok.

Parametre

Parameter Povinný Popis
title povinný Názov nového priečinka.
dir_id voliteľný Rodičovský priečinok, kde má byť nový priečinok vytvorený. Nechajte prázdne pre vytvorenie v koreňovom adresári.
PATCH /directory

Premenuje priečinok alebo ho presunie do iného nadradeného priečinka.

Parametre

Parameter Povinný Popis
dir_id povinný ID priečinka, ktorý má byť presunutý alebo premenovaný.
title voliteľný Zadajte nový názov na premenovanie priečinka.
parent_id voliteľný ID nového nadradeného priečinka pri presune priečinka.
DELETE /directory

Odstráni priečinok.

Parametre

Parameter Povinný Popis
dir_id povinný ID priečinka na odstránenie.
POZNÁMKA

Táto metóda odstráni iba samotný priečinok. NEodstráni súbory, ktoré sa v ňom nachádzajú. Všetky podpriečinky sú odstránené rekurzívne.

GET /sentence/search

Vyhľadávanie viet vo vašich prepisoch.

Parametre

Parameter Povinný Popis
query povinný Vyhľadávací dopyt. Podporuje operátory "OR", "AND" a zástupný znak (*).
_from voliteľný Index prvého záznamu na vrátenie.
_max voliteľný Maximálny počet vrátených záznamov.
dir_ids voliteľný Zoznam ID priečinkov, v ktorých sa má vyhľadávať. Nechajte prázdne pre globálne vyhľadávanie.
lang voliteľný Jazyk viet, v ktorom sa má vyhľadávať.

Záver

Naše API nemá žiadne obmedzenia okrem mesačnej kvóty definovanej vaším predplatným. Pre technickú podporu nás môžete kedykoľvek kontaktovať na contact@streams.guru. Neustále rozširujeme naše endpointy a pridávame nové funkcie.

GASTON REST API — kompletná OpenAPI špecifikácia →