Wyeksportuj transkrypcję

curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_export' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"historyId":"history_20261016_001","format":"paragraphs"}'

const input = {
  historyId: 'history_20261016_001',
  format: 'paragraphs',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_export', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/transcription_export",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"historyId": "history_20261016_001", "format": "paragraphs"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "fileName": "interview.txt",
    "contentType": "text/plain; charset=utf-8",
    "content": "Hello world."
  }
}

POST

actions

transcription_export

curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_export' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"historyId":"history_20261016_001","format":"paragraphs"}'

const input = {
  historyId: 'history_20261016_001',
  format: 'paragraphs',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_export', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/transcription_export",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"historyId": "history_20261016_001", "format": "paragraphs"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

{
  "data": {
    "fileName": "interview.txt",
    "contentType": "text/plain; charset=utf-8",
    "content": "Hello world."
  }
}

Wyeksportuj zapisany tekst transkrypcji jako surowy tekst, akapity lub zdania.

POST https://api.voicecheap.ai/v1/actions/transcription_export

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.Minimalna długość: 1. Maksymalna długość: 160. Wzorzec: ^[A-Za-z0-9_-]+$.

string

Wartość tekstowa.Dozwolone wartości: “raw”, “paragraphs”, “sentences”. Wartość domyślna: “paragraphs”.

Pełny schemat danych wejściowych

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.

{
  "type": "object",
  "properties": {
    "historyId": {
      "type": "string",
      "minLength": 1,
      "maxLength": 160,
      "pattern": "^[A-Za-z0-9_-]+$"
    },
    "format": {
      "default": "paragraphs",
      "type": "string",
      "enum": ["raw", "paragraphs", "sentences"]
    }
  },
  "required": ["historyId"],
  "additionalProperties": false
}

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.

curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_export' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"historyId":"history_20261016_001","format":"paragraphs"}'

const input = {
  historyId: 'history_20261016_001',
  format: 'paragraphs',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_export', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/transcription_export",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"historyId": "history_20261016_001", "format": "paragraphs"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

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. Wyeksportowany zapisany tekst transkrypcji z oczyszczoną nazwą pliku .txt i tekstowym typem MIME.

{
  "data": {
    "fileName": "interview.txt",
    "contentType": "text/plain; charset=utf-8",
    "content": "Hello world."
  }
}

Pola wyniku

Pole	Opis
`data.fileName`	Sugerowana oczyszczona lokalna nazwa pliku z rozszerzeniem żądanego formatu.
`data.contentType`	Typ MIME eksportowanego tekstu.
`data.content`	Pełny wyeksportowany tekst jako ciąg znaków JSON.

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.
format akceptuje raw, paragraphs lub sentences i ma domyślną wartość paragraphs. Treść jest pobierana z odpowiedniego zapisanego wariantu transkrypcji.
Zwraca tekst wewnątrz JSON. Zapisz ciąg tekstowy content w pliku o zwróconej nazwie fileName; ta akcja nie zwraca mediów binarnych ani publicznego adresu URL transkrypcji.
Wyjściowa nazwa pliku jest oczyszczana na podstawie zapisanej nazwy źródłowej, a jej nazwa bazowa jest ograniczona do 180 znaków. Eksport odczytuje istniejącą historię i nie zużywa przesłanego pliku źródłowego ani dziennego limitu narzędzia.

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

Status HTTP	Kod	Znaczenie lub sposób rozwiązania
400	`CREDENTIAL_IN_QUERY`	Dane uwierzytelniające zostały podane w parametrze zapytania access_token lub api_key. Wysyłaj dane uwierzytelniające w nagłówkach.
400	`VALIDATION_ERROR`	Argumenty nie spełniają schematu akcji lub podano nieznany argument.
401	`API_KEY_EXPIRED`	Klucz API wygasł.
401	`INVALID_API_KEY`	Podaj prawidłowy, niewygasły klucz API.
401	`INVALID_CREDENTIAL`	Nagłówek Authorization ma nieprawidłowy format lub jest sprzeczny z x-api-key.
401	`MISSING_CREDENTIAL`	Nie podano użytecznych danych uwierzytelniających w nagłówku lub przekroczyły one 4096 znaków.
401	`USER_NOT_FOUND`	Konto powiązane z poświadczeniem już nie istnieje.
403	`AMBIGUOUS_TEAM_API_KEY`	Użytkownik, do którego należą dane uwierzytelniające, należy do więcej niż jednego zespołu, więc kontekst rozliczeniowy jest niejednoznaczny.
403	`INSUFFICIENT_SCOPE`	Klucz API lub połączenie MCP nie ma uprawnienia wymaganego do wykonania tej akcji.
403	`INTEGRATION_PLAN_UNSUPPORTED`	Nie udało się zweryfikować limitów integracji konta.
403	`PAID_SUBSCRIPTION_REQUIRED`	Uwierzytelniony wywołujący nie ma już płatnej subskrypcji w chwili wykonywania tej akcji narzędzia.
403	`SUBSCRIPTION_REQUIRED`	Użyj aktywnej płatnej subskrypcji.
403	`TEAM_OWNER_NOT_FOUND`	Nie znaleziono konta faktycznego właściciela zespołu.
404	`TRANSCRIPTION_HISTORY_NOT_FOUND`	Odpowiedni zapisany element historii nie istnieje dla tego podmiotu wykonującego akcję.
429	`INTEGRATION_MONTHLY_LIMIT_REACHED`	Wykorzystane i oczekujące wywołania osiągnęły wspólny miesięczny limit API/MCP.
429	`INTEGRATION_RATE_LIMIT_REACHED`	Konto osiągnęło limit integracji na minutę; sprawdź retryAfterSeconds.
500	`INTERNAL_ERROR`	Nie udało się odczytać zapisanej treści eksportu.
503	`SERVER_RESTARTING`	Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane.

{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["transcription:read"]
  }
}

Przegląd

Wykrywanie

Konto

Wykorzystanie i aktywność

Ustawienia i powiadomienia

Zespół

Projekty

Tłumaczenie i dubbing

Transkrypcje i edycja

Zamiana tekstu na mowę

Głosy do syntezy mowy

Głosy dubbingowe

Transkrypcja

Napisy

Obrazy

Miniatury

Foldery

Glosariusz

Webhooki

Publikowanie

Stan żądania

OAuth i protokół MCP

Uwierzytelnianie i uprawnienia

Parametry

Przykłady żądań

Odpowiedź

Pola wyniku

Uwagi do operacji

Wykorzystanie

Błędy

​Uwierzytelnianie i uprawnienia

​Parametry

​Przykłady żądań

​Odpowiedź

​Pola wyniku

​Uwagi do operacji

​Wykorzystanie

​Błędy

Uwierzytelnianie i uprawnienia

Parametry

Przykłady żądań

Odpowiedź

Pola wyniku

Uwagi do operacji

Wykorzystanie

Błędy