> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Ottieni o esporta la trascrizione di un progetto
> Recupera la trascrizione originale o tradotta come JSON, SRT o VTT, con etichette dei parlanti facoltative.
Recupera la trascrizione originale o tradotta come JSON, SRT o VTT, con etichette dei parlanti facoltative.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/transcripts_get
```
## Autenticazione e autorizzazioni
Invia una chiave API VoiceCheap in questa intestazione. È supportato anche Authorization: Bearer con la stessa chiave API. I token di accesso OAuth
sono accettati solo da MCP, non da questo endpoint REST.
Autorizzazioni richieste: `transcription:read`.
È necessario un abbonamento a pagamento attivo. Le autorizzazioni non modificano i ruoli del team, la proprietà delle risorse, i crediti multimediali o i limiti del piano.
## Parametri
Valore testuale.
Lunghezza minima: 1. Lunghezza massima: 200. Pattern: `^[^/\\]+$`.
Valore testuale.
Valori consentiti: "original", "translated". Valore predefinito: "original".
Valore testuale.
Valori consentiti: "afrikaans", "albanian", "amharic", "arabic", "armenian", "assamese", "azerbaijani", "basque", "belarusian", "bengali", "bosnian", "bulgarian", "catalan", "croatian", "czech", "danish", "dutch", "english", "british english", "estonian", "finnish", "french", "french canadian", "galician", "german", "greek", "gujarati", "hebrew", "hindi", "hungarian", "icelandic", "indonesian", "irish", "italian", "japanese", "kannada", "kazakh", "khmer", "korean", "lao", "latvian", "lithuanian", "macedonian", "malay", "malayalam", "mandarin", "marathi", "mongolian", "nepali", "norwegian", "persian", "polish", "portuguese", "brazilian portuguese", "pt\_brazil", "punjabi", "romanian", "russian", "serbian", "slovak", "slovenian", "spanish", "swahili", "swedish", "tagalog", "tamil", "telugu", "thai", "turkish", "ukrainian", "urdu", "vietnamese", "welsh", "yoruba", "zulu".
Valore testuale.
Valori consentiti: "json", "srt", "vtt". Valore predefinito: "json".
Valore booleano.
Valore predefinito: false.
Il JSON Schema seguente conserva i nomi esatti dei campi, i tipi annidati, i valori predefiniti, i limiti e i valori accettati esposti dalla discovery. Le ulteriori regole tra campi sono elencate nelle note sull'operazione.
```json theme={null}
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"source": {
"default": "original",
"type": "string",
"enum": ["original", "translated"]
},
"targetLanguage": {
"type": "string",
"enum": [
"afrikaans",
"albanian",
"amharic",
"arabic",
"armenian",
"assamese",
"azerbaijani",
"basque",
"belarusian",
"bengali",
"bosnian",
"bulgarian",
"catalan",
"croatian",
"czech",
"danish",
"dutch",
"english",
"british english",
"estonian",
"finnish",
"french",
"french canadian",
"galician",
"german",
"greek",
"gujarati",
"hebrew",
"hindi",
"hungarian",
"icelandic",
"indonesian",
"irish",
"italian",
"japanese",
"kannada",
"kazakh",
"khmer",
"korean",
"lao",
"latvian",
"lithuanian",
"macedonian",
"malay",
"malayalam",
"mandarin",
"marathi",
"mongolian",
"nepali",
"norwegian",
"persian",
"polish",
"portuguese",
"brazilian portuguese",
"pt_brazil",
"punjabi",
"romanian",
"russian",
"serbian",
"slovak",
"slovenian",
"spanish",
"swahili",
"swedish",
"tagalog",
"tamil",
"telugu",
"thai",
"turkish",
"ukrainian",
"urdu",
"vietnamese",
"welsh",
"yoruba",
"zulu"
]
},
"outputFormat": {
"default": "json",
"type": "string",
"enum": ["json", "srt", "vtt"]
},
"includeSpeakerLabels": {
"default": false,
"type": "boolean"
}
},
"required": ["projectId"],
"additionalProperties": false
}
```
## Esempi di richiesta
Sostituisci gli identificatori delle risorse e le chiavi multimediali di esempio con i valori restituiti per il tuo account. Mantieni stabile l'identificatore della richiesta quando ripeti la stessa modifica.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/transcripts_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","source":"original","outputFormat":"json","includeSpeakerLabels":false}'
```
```javascript JavaScript theme={null}
const input = {
projectId: 'project_launch_2026',
source: 'original',
outputFormat: 'json',
includeSpeakerLabels: false,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcripts_get', {
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);
```
```python Python theme={null}
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/transcripts_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "source": "original", "outputFormat": "json", "includeSpeakerLabels": False},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## Risposta
Una prima esecuzione riuscita restituisce HTTP 200 con il risultato dell'operazione in data. Una ripetizione può invece restituire lo stato della richiesta salvata. L'esempio mostra una risposta supportata, non tutti i campi facoltativi.
Restituisce un oggetto di trascrizione formattato. Il JSON contiene format, transcript e contentType; SRT/VTT includono anche content e fileExtension.
```json HTTP 200 theme={null}
{
"data": {
"format": "json",
"transcript": {
"source": "original",
"language": "fr",
"duration": 75,
"text": "Bienvenue au lancement.",
"speakers": [
{
"id": 0,
"label": "Speaker 1"
}
],
"segments": [
{
"index": 0,
"text": "Bienvenue au lancement.",
"begin": 0,
"end": 2,
"duration": 2,
"speaker": 0,
"language": "fr"
}
]
},
"contentType": "application/json"
}
}
```
## Campi del risultato
| Campo | Descrizione |
| - | - |
| `data.format` | json, srt o vtt. |
| `data.contentType` | application/json, application/x-subrip; charset=utf-8, oppure text/vtt; charset=utf-8. |
| `data.content` | Testo dei sottotitoli solo per srt/vtt. |
| `data.fileExtension` | srt o vtt solo per le esportazioni di testo. |
| `data.transcript.source` | original o translated. |
| `data.transcript.language` | Lingua della trascrizione. |
| `data.transcript.duration` | Il massimo tra la durata multimediale archiviata e la fine dell'ultimo segmento, in secondi. |
| `data.transcript.text` | Testo dei segmenti non vuoti concatenato. |
| `data.transcript.speakers` | Parlanti univoci ordinati per id numerico, con etichette Speaker N generate. |
| `data.transcript.segments` | Segmenti normalizzati ordinati per begin e index, con index, text, begin, end, duration, speaker, language e, facoltativamente, confidence, finalSpeedFactor, words. |
| `data.transcript.workId` | Incluso per una trascrizione tradotta. |
| `data.transcript.targetLanguage` | Incluso per una trascrizione tradotta. |
| `data.transcript.segments[].begin` | Tempo di inizio in secondi, normalizzato a tre cifre decimali. |
| `data.transcript.segments[].end` | Tempo di fine in secondi, normalizzato a tre cifre decimali. |
| `data.transcript.segments[].duration` | Durata positiva del segmento in secondi. |
| `data.transcript.segments[].speaker` | Numero del parlante con indice a partire da zero. |
| `data.transcript.segments[].finalSpeedFactor` | Durata facoltativa della voce tradotta divisa per la finestra temporale del relativo segmento, arrotondata a tre decimali; valori superiori a 1 indicano che è stato necessario accelerare la voce. |
## outputFormat srt; source translated, targetLanguage english, includeSpeakerLabels true.
Restituisce la trascrizione tradotta e il contenuto SRT con i prefissi dei parlanti.
```json HTTP 200 theme={null}
{
"data": {
"format": "srt",
"transcript": {
"source": "translated",
"language": "english",
"duration": 75,
"text": "Welcome to the product launch.",
"speakers": [
{
"id": 0,
"label": "Speaker 1"
}
],
"segments": [
{
"index": 0,
"text": "Welcome to the product launch.",
"begin": 0,
"end": 2,
"duration": 2,
"speaker": 0,
"language": "english",
"finalSpeedFactor": 1.08
}
],
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
},
"content": "1\n00:00:00,000 --> 00:00:02,000\nSpeaker 1: Welcome to the product launch.\n",
"contentType": "application/x-subrip; charset=utf-8",
"fileExtension": "srt"
}
}
```
## outputFormat vtt; source translated, targetLanguage english, includeSpeakerLabels true.
Restituisce la trascrizione tradotta e il contenuto WEBVTT con etichette delle voci.
```json HTTP 200 theme={null}
{
"data": {
"format": "vtt",
"transcript": {
"source": "translated",
"language": "english",
"duration": 75,
"text": "Welcome to the product launch.",
"speakers": [
{
"id": 0,
"label": "Speaker 1"
}
],
"segments": [
{
"index": 0,
"text": "Welcome to the product launch.",
"begin": 0,
"end": 2,
"duration": 2,
"speaker": 0,
"language": "english",
"finalSpeedFactor": 1.08
}
],
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"targetLanguage": "english"
},
"content": "WEBVTT\n\n1\n00:00:00.000 --> 00:00:02.000\nWelcome to the product launch.\n",
"contentType": "text/vtt; charset=utf-8",
"fileExtension": "vtt"
}
}
```
## Note sull'operazione
* Il valore predefinito di source è original, quello di outputFormat è json e quello di includeSpeakerLabels è false. Una sorgente con valore translated richiede targetLanguage.
* Per le trascrizioni tradotte viene selezionato il lavoro linguistico più recente corrispondente a targetLanguage. Questa azione non accetta workId o translatedVersionId come input.
* Le esportazioni SRT e VTT rimangono risultati JSON dell'azione: content contiene il testo dei sottotitoli e transcript rimane disponibile nello stesso oggetto. Questo gestore non restituisce una risposta grezza scaricabile.
* includeSpeakerLabels influisce soltanto sui blocchi di esportazione testuale: SRT usa prefissi Speaker N: e VTT usa tag voice.
* Le parole della trascrizione archiviate, quando presenti, espongono index, text, speaker e il campo facoltativo confidence; non vengono inventati timestamp a livello di parola. I segmenti tradotti possono esporre finalSpeedFactor quando sono disponibili i dati temporali dell'audio vocale generato.
## Utilizzo
Ogni invocazione riuscita consuma una chiamata API/MCP mensile. Si applicano anche i crediti multimediali e le quote di generazione proprie dell'operazione.
## Errori
| Stato HTTP | Codice | Significato o risoluzione |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Le credenziali sono state fornite in un parametro di query access\_token o api\_key. Invia le credenziali negli header. |
| 400 | `VALIDATION_ERROR` | Correggi l'input usando lo schema. I valori non validi o incoerenti vengono rifiutati prima dell'esecuzione. |
| 401 | `API_KEY_EXPIRED` | La chiave API è scaduta. |
| 401 | `INVALID_API_KEY` | Fornisci una chiave API valida e non scaduta. |
| 401 | `INVALID_CREDENTIAL` | L'header Authorization non è valido oppure è in conflitto con x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Non è stata fornita alcuna credenziale utilizzabile negli header, oppure la credenziale superava 4096 caratteri. |
| 401 | `USER_NOT_FOUND` | L'account associato alla credenziale non esiste più. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | L'utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo. |
| 403 | `FORBIDDEN` | L'utente chiamante autenticato non può accedere a questo progetto. |
| 403 | `INSUFFICIENT_SCOPE` | Concedi tutte le autorizzazioni richieste o scegli un'altra credenziale. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Impossibile verificare i limiti di integrazione dell'account. |
| 403 | `SUBSCRIPTION_REQUIRED` | Usa un abbonamento a pagamento attivo. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Non è stato possibile trovare l'account effettivo del proprietario del team. |
| 404 | `PROJECT_NOT_FOUND` | Il progetto non esiste nell'account accessibile. |
| 404 | `TRANSCRIPT_NOT_FOUND` | Non esiste alcuna trascrizione utilizzabile per la sorgente e la lingua di destinazione richieste. |
| 409 | `TRANSCRIPT_NOT_READY` | La trascrizione originale o tradotta richiesta è ancora in stato processing. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Attendi il ripristino mensile o cambia piano. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Rispetta Retry-After quando presente e applica attese crescenti tra i tentativi. |
| 500 | `INTERNAL_ERROR` | Controlla lo stato della richiesta salvata e la cronologia delle risorse prima di decidere se ripetere una modifica. |
| 503 | `SERVER_RESTARTING` | Il server si sta riavviando. Riprova tra poco e mantieni lo stesso identificatore della richiesta per una modifica. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["transcription:read"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.