GASTON REST API

GASTON ponúka jednoduché REST API rozhranie, ktorým si môžeš svoje aplikácie a webstránky pripojiť k našim službám a prepisovať videá, zvukové stopy.

Samotné prepisovanie súborov je asynchrónne, teda po nahratí súboru na naše API, dostaneš ID súboru, ktorý sa postupne spracúva. Extrahuje sa zvuková stopa, vytvorí sa spektrogram, deteguje sa jazyk v ktorom sa hovorí až po samotnú transkripciu. Stav, v ktorom sa daný súbor práve nachádza, rovnako ako získanie prepisu a ostatných informácií sa realizuje cez endpoint /media. Všetky prepísané súbory sa ukladajú do knižnice, rovnako ako keby boli pridané cez našu webovú apku.

Autentifikácia

API kľúč je nutné vložiť do HTTP Hlavičky pri každom dotaze. Po prihlásení si vo svojich nastaveniach vygeneruj API kľúč, ktorý slúži na autorizáciu voči našej REST API. Napríklad:

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

Kľúč si môžeš kedykoľvek zmeniť vo svojich nastaveniach.

Popis jednotlivých endpointov

Presnú technickú špecifikáciu fo formáte openapi 3.1 nájdeš tu, nasleduje jednoduchý popis endpointov.

/user/me

Endpoint slúži na získanie základných informácií o autentifikovanom používateľovi a obsahuje aj informácie o využití služby - mesačná kvóta a aktuálne využitie služby.

/media

Endpoint vráti kompletné informácie o súbore, vrátane prepisu, časovaní slov, a dostupných prekladoch. Okrem parametra media_id je k dispozícií aj parameter lang ktorý definuje, ktorá jazyková mutácia prepisu sa má vylistovať. Ak je zadaný lang=en a súbor je preložený do angličtiny, vylistujú sa anglické vety.

/media/list

Endpoint na vylistovanie už spracovaných súborov v knižnici. Ako jediný parameter je k dispozícií číslo strany, ktoré chceš vylistovať. Súbory sa stránkujú po 50 záznamoch a sú zoradené od najnovšieho po najstarší. Informácie o súboroch sú stručné a neobsahujú samotný textový prepis súboru.

/media/transcribe

Endpoint pre upload mediálneho súboru na prepis. Maximálna veľkosť súboru je 2Gb. Endpoint má možnosť špecifikovať jazyk ktorým sa v nahrávke rozpráva. Ak nie je jazyk uvedený, bude sa automaticky detegovať. V prípade, že je jazyk známy, odporúča sa ho uviesť pre lepšiu rýchlosť. Endpoint podporuje aj nastavenie názvu súboru v knižnici. Ak nie je uvedený použije sa meno súboru. Po úspešnom zavolaní endpoint odpovie informáciou o ID súboru a jeho stave.

/media/transcribe-url

Rovnako ako predchádzajúci endpoint, tento slúži na prepis videa z URL adresy jednej s podporovaných streamovacích služieb. Po zadaní URL videa sa súbor automaticky stiahne a spracuje. Ak je teda napríklad poskytnutá URL adresa https://www.youtube.com/watch?v=-fke4tqK0cY, GASTON stiahne video a všetky informácie o ňom vrátane obrázku a samozrejme súbor prepíše.

/media/translate

Preloží už prepísaný súbor do zvoleného jazyka. Aktuálne je k dispozícií len angličtina. Progres prekladu do daného jazyka, ako aj dostupné jazykové mutácie pre každý súbor indikuje asociatívne poleavailable_languages. Kde kľúčom je názov jazyka a hodnotou percentuálne vyjadrenie progresu prekladu.

Napríklad nasledovný stav znamená, že súbor je 100% prepísaný do slovenčiny, a preklad do angličtiny ešte prebieha a nachádza sa na 66%: available_languages: { sk: 100, en: 66 }

Záver

Naša API nie je žiadno limitovaná (až na mesačnú kvótu podľa používateľovho programu). Pre technickú podporu píš kedykoľvek na contact@streams.guru. Endpointy ako aj funkcionalitu neustále rozširujeme.

GASTON REST API