Skip to main content

​
Dokumentacja API

API VoiceCheap korzysta ze standardowych metod i kodów stanu HTTP. Większość punktów końcowych zwraca JSON, a eksport transkrypcji może zwracać także SRT lub VTT. Do ustawień konta, zarządzania zespołem, narzędzi multimedialnych i innych procesów używaj katalogu akcji. Te procesy są również dostępne przez serwer MCP konta, z wyjątkiem tworzenia i rotacji sekretu podpisywania webhooków, które wymagają REST. Zarządzaj poświadczeniami w Integracjach i sprawdź limity użycia.

​
Podstawowy adres URL

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

​
Uwierzytelnianie

Uwierzytelniaj prywatne wywołania REST kluczem API w x-api-key lub Authorization: Bearer. Dokument OpenAPI jest publiczny. Informacje o poświadczeniach o ograniczonych uprawnieniach i OAuth dla MCP znajdziesz na stronie Uwierzytelnianie.

​
API akcji JSON

Sekcje konta, zespołu, projektów, głosów i narzędzi multimedialnych opisują każdą akcję JSON osobno. Wszystkie te ścieżki używają POST, także do odczytu i usuwania; argumenty wysyłaj w treści JSON. Poniższe ścieżki przesyłania plików i istniejących projektów zachowują własne metody HTTP. Utwórz klucz API z uprawnieniem account:read, ustaw zmienną środowiskową VOICECHEAP_API_KEY i wypróbuj to żądanie tylko do odczytu:
Zakończona akcja zwraca HTTP 200 z wynikiem w data. Dłuższa akcja zwraca HTTP 202 i requestId; odczytaj stan żądania, aby odzyskać wynik. Zadanie multimedialne może trwać po zakończeniu żądania akcji. Przejrzyj wszystkie akcje według obszaru lub sprawdź akcje i schematy dostępne dla Twojego klucza. Każda strona podaje uprawnienia, parametry, przykłady i błędy.

​
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.

​
Przesyłanie plików i istniejące ścieżki projektów

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.

Utwórz projekt

POST /v1/projectsPrześlij plik wideo lub audio i rozpocznij samą transkrypcję.

Rozpocznij tłumaczenie

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

Zdubbinguj projekt

POST /v1/projects/{projectId}/dubZdubbinguj projekt z gotową transkrypcją na podstawie własnego przetłumaczonego pliku SRT.

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

Poniższe istniejące ścieżki plików i projektów zachowują własne formaty odpowiedzi. Pola poprawnej odpowiedzi zależą od punktu końcowego. Utworzenie projektu i rozpoczęcie dubbingu zwracają success, message i projectId. Zapytania o status i szczegóły zwracają stan projektu, a żądania transkrypcji zwracają JSON, SRT lub VTT. Dokładne pola opisano na stronie każdego punktu końcowego. Błędy zwracają obiekt JSON z code i message, czasem również z details. Zobacz Kody błędów.

​
Kody stanu HTTP