Skip to main content

​
Dokumentacja API

API VoiceCheap jest zorganizowane zgodnie z zasadami REST. Wykorzystuje standardowe metody HTTP, zwraca odpowiedzi zakodowane w formacie JSON i używa standardowych kodów odpowiedzi HTTP.

​
Podstawowy adres URL

Wszystkie żądania API należy kierować na adres:

​
Uwierzytelnianie

Wszystkie żądania wymagają klucza API przekazanego w nagłówku x-api-key. Szczegóły znajdują się na stronie Uwierzytelnianie.

​
Typy zawartości

  • Żądanie: Użyj multipart/form-data do przesyłania plików, application/json dla pozostałych żądań
  • Odpowiedź: Punkty końcowe JSON zwracają application/json. Eksporty transkrypcji mogą również zwracać tekst w formacie SRT lub VTT.

​
Dostępne punkty końcowe

Transkrypcja mediów

POST /v1/transcribeTranskrybuj przesłany plik do formatu JSON, SRT lub VTT.

Eksport transkrypcji projektu

POST /v1/projects/{projectId}/transcriptPobierz oryginalne lub przetłumaczone transkrypcje projektu.

Rozpocznij tłumaczenie

POST /v1/translatePrześlij plik wideo lub audio i rozpocznij projekt tłumaczeniowy.

Pobierz status tłumaczenia

GET /v1/translate/{projectId}/statusSprawdź status projektu tłumaczeniowego i pobierz wyniki.

Pobierz szczegóły projektu

GET /v1/projects/{projectId}Pobierz historię przetłumaczonych wersji, historię synchronizacji ruchu ust oraz stan projektu.

Usuń projekt

DELETE /v1/translate/{projectId}Trwale usuń projekt tłumaczeniowy oraz powiązane z nim zasoby.

​
Przepływ pracy tłumaczenia

Typowy przepływ pracy przy tłumaczeniu wideo wygląda następująco:

​
Format odpowiedzi

Wszystkie poprawne odpowiedzi mają następującą ogólną strukturę:
Odpowiedzi z błędami mają następującą strukturę:

​
Kody stanu HTTP