Skip to main content
POST
Odczytaj metadane zapisanego wyniku. Ustaw includeContent=true, aby pobrać pełny uporządkowany JSON, w tym wszystkie słowa napisów lub tekst transkrypcji.

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: transcription:read. 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.Format: “uuid”. Wzorzec: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.
boolean
Wartość logiczna.Wartość domyślna: false.
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.

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ź

Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól. Metadane zapisanego wyniku oraz pełny ustrukturyzowany wynik, gdy includeContent ma wartość true. Pominięcie includeContent zwraca wyłącznie metadane.

Pola wyniku

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.
  • resultId to UUID z referencji ukończonego generowania lub result_list tej domeny. Różni się od requestId akcji i historyId narzędzia internetowego.
  • Wyniki należą do uwierzytelnionego użytkownika i domeny uprawnień. Wyniku subtitles nie można odczytać przez akcje transcription ani odwrotnie.
  • Pełny zapisany JSON jest szyfrowany podczas przechowywania i zachowywany niezależnie od ograniczonej pamięci podręcznej sprawdzania stanu akcji. Pobieranie nadal wymaga uwierzytelnienia; publiczny adres URL pliku JSON transkrypcji lub napisów nie jest udostępniany.
  • Te akcje pobierają istniejący wynik i nie generują multimediów ani nie zużywają dziennego limitu. Każde udane pobranie nadal zużywa jedno miesięczne wywołanie integracji.
  • Metadane ze statusem pending oznaczają, że zapis wyniku wymaga odzyskania. Odczyt treści lub pobieranie podejmują próbę odzyskania już zapisanego zaszyfrowanego obiektu; sprawdź go przed rozpoczęciem kolejnego generowania.
  • includeContent ma domyślną wartość false. true odszyfrowuje i zwraca pełny wygenerowany JSON w result. Ten przykład przedstawia wariant zwracający treść.
  • Struktura zagnieżdżonego wyniku odpowiada jego pierwotnej operacji. Wyjścia transkrypcji zawierają tekst transkrypcji, wyjścia napisów mogą zawierać dane SRT lub wyrenderowanego wideo, a napisy słowne zawierają tekst słowa, startMs/endMs, speakerId dopuszczające null oraz durationSeconds.

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