Skip to main content
POST
Zaimportuj do konta bezpośredni publiczny adres URL HTTPS pliku audio lub wideo. Przekierowania i sieci prywatne są odrzucane; obowiązują limity pliku i czasu trwania. Użyj otrzymanego fileKey w akcji generowania.

Uwierzytelnianie i uprawnienia

string
wymagane
Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są akceptowane tylko przez MCP, a nie przez ten endpoint REST.
Wymagane uprawnienia: subtitles:write. Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.

Parametry

string
wymagane
Wartość tekstowa.Maksymalna długość: 4096. Format: “uri”.
string
Wartość tekstowa.Minimalna długość: 1. Maksymalna długość: 255. Wzorzec: ^[^/\\\r\n\0]+$.
string
wymagane
Wartość tekstowa.Dozwolone wartości: “transcription”, “video_to_srt”, “add_subtitles”, “animated_captions”, “project”.
string
Opcjonalne na poziomie transportu: jeśli identyfikator zostanie pominięty, serwer doda go przed walidacją. Podaj własny, stały UUID v4, aby bezpiecznie odzyskać wynik po utracie odpowiedzi.Format: “uuid”. Wzorzec: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.

Idempotencja

Dla każdej operacji zmieniającej dane użyj UUID v4 w requestId lub w nagłówku HTTP Idempotency-Key. Po awarii sieci użyj ponownie tego samego identyfikatora i identycznych argumentów. Jeśli podasz oba, muszą być zgodne. Ponowienie zapisanego żądania nie powtarza operacji ani nie zużywa kolejnego wywołania z miesięcznego limitu. Żądania zakończone błędem lub przerwane nie są automatycznie uruchamiane ponownie. Każda operacja zmieniająca dane może zwrócić HTTP 202, gdy ponowienie napotka to samo żądanie nadal w stanie running, nawet jeśli jej pierwsze wykonanie zwykle jest synchroniczne. Jeśli wykonanie się zakończyło, ale resultStored ma wartość false, ponowienie zwraca HTTP 200 z zapisanym stanem żądania zamiast pierwotnego wyniku. Pobierz wynik za pomocą akcji historii, wyniku lub pobierania właściwej dla danej domeny.

Przykłady żądań

Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.

Odpowiedź

Ta operacja zwraca HTTP 202 podczas przetwarzania. Zapisz requestId i odpytuj action_request_get, podając ten identyfikator oraz nazwę pierwotnej operacji. Stany odpytywania to running, completed, failed i interrupted. Zakończony wynik może wskazywać osobne zadanie przetwarzania multimediów; kontynuuj za pomocą akcji stanu lub wyniku właściwej dla tej operacji. Zaimportowane odwołanie do multimediów należących do użytkownika wykonującego wywołanie, ze zweryfikowanym rozmiarem, czasem trwania, rodzajem multimediów i adresem URL odczytu. Jest to ukończony wynik akcji, dostępny po sprawdzeniu stanu.

Pola wyniku

Odzyskaj żądanie i sprawdź jego stan

Używaj tego samego identyfikatora także po utracie połączenia. Jeśli resultStored ma wartość false, pobierz wynik za pomocą odpowiedniej akcji historii, wyniku lub pobierania. Nigdy nie uruchamiaj drugiego generowania tylko po to, aby sprawdzić postęp.
HTTP 200

Uwagi do operacji

  • Wymaga płatnej subskrypcji i uprawnienia do akcji. Osobisty plan narzędzi użytkownika wykonującego żądanie jest ponownie sprawdzany podczas wykonywania; zapisane narzędzia i referencje przesłanych plików należą do tego użytkownika, również gdy dane uwierzytelniające są powiązane z zespołem.
  • Pomyślna akcja zużywa jedno wspólne miesięczne wywołanie API/MCP. Beginner pozwala na 500, Starter na 5,000, a Creator na 25,000 wywołań miesięcznie; Pro, Scale i Enterprise nie mają miesięcznego limitu. Nadal obowiązują limity na minutę: odpowiednio 30, 60, 120, 180, 300 i 600. Limity generowania narzędzi są odrębne.
  • Użyj requestId w formacie UUID v4 lub identycznego nagłówka Idempotency-Key i przy ponawianiu zachowuj tę samą akcję, identyfikator i argumenty. Odtworzenie zapisanej odpowiedzi nie zużywa kolejnego miesięcznego wywołania.
  • Prefiks przesyłania określa wymagane uprawnienie. tools używa transcription:write, subtitles używa subtitles:write, projects używa projects:write, a voices używa voices:write.
  • Dla narzędzi, napisów i projektów kind przyjmuje transcription, video_to_srt, add_subtitles, animated_captions lub project. Wybrane kind określa limity procesu; prefiks nie wymusza kind.
  • Wybrane kind stosuje własne limity: transcription 200 MiB; video_to_srt i add_subtitles 300 MiB; animated_captions 250 MiB i wyłącznie audio; project stosuje limit przesyłania z planu (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). Samodzielne multimedia mogą trwać maksymalnie 2 godziny. Napisy dopuszczają 30 minut w planie Beginner i 60 minut w wyższych planach publicznych, z dodatkową tolerancją kontenera wynoszącą 2 sekundy. Projekt może trwać maksymalnie 2 godziny lub 3 godziny w planie Enterprise.
  • Ta akcja działa asynchronicznie. Sprawdzaj action_request_get, podając nazwę operacji i pierwotny requestId, aż do ukończenia, zanim pobierzesz fileKey z wyniku.
  • Użyj bezpośredniego publicznego adresu URL HTTPS pliku audio lub wideo. Przekierowania, dane uwierzytelniające, fragmenty, porty inne niż 443 i niepubliczne adresy DNS są odrzucane. Strona odtwarzania YouTube nie jest bezpośrednim adresem URL multimediów; użyj dedykowanych akcji YouTube.
  • filename jest opcjonalne, gdy ścieżka adresu URL kończy się obsługiwaną nazwą pliku multimedialnego. Zapisywana nazwa pliku jest oczyszczana. Serwer bada rzeczywisty czas trwania przed zwróceniem fileKey.
  • Import przygotowuje multimedia i zużywa jedno udane wywołanie z miesięcznego limitu integracji; dzienny limit generowania w narzędziu jest zużywany dopiero przez późniejsze generowanie.

Wykorzystanie

Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.

Błędy