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

# Inizializza un caricamento multimediale (campioni vocali)

> Avvia un caricamento multiparte di tua proprietà. Carica ogni parte al relativo URL firmato, quindi completa il caricamento prima di chiamare un'azione di generazione.

Avvia un caricamento multiparte di tua proprietà. Carica ogni parte al relativo URL firmato, quindi completa il caricamento prima di chiamare un'azione di generazione.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/voices_upload_initialize
```

## Autenticazione e autorizzazioni

<ParamField header="x-api-key" type="string" required>
  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.
</ParamField>

Autorizzazioni richieste: `voices:write`.

È 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

<ParamField body="filename" type="string" required>
  Valore testuale.

  Lunghezza minima: 1. Lunghezza massima: 255. Pattern: `^[^/\\\r\n\0]+$`.
</ParamField>

<ParamField body="contentType" type="string" required>
  Valore testuale.

  Valori consentiti: "audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/x-m4a", "audio/ogg", "audio/opus", "audio/x-opus".
</ParamField>

<ParamField body="fileSize" type="integer" required>
  Valore intero.

  Massimo: 20971520.
</ParamField>

<ParamField body="kind" type="string">
  Valore testuale.

  Valore obbligatorio: "voice\_sample". Valore predefinito: "voice\_sample".
</ParamField>

<ParamField body="requestId" type="string">
  Facoltativo al livello di trasporto: se omesso, il server inserisce un identificatore prima della validazione. Fornisci un tuo UUID v4 stabile per recuperare in sicurezza una risposta persa.

  Formato: "uuid". Pattern: `^[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}$`.
</ParamField>

<Accordion title="Schema di input completo">
  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": {
      "filename": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[^/\\\\\\r\\n\\0]+$"
      },
      "contentType": {
        "type": "string",
        "enum": ["audio/mpeg", "audio/mp3", "audio/wav", "audio/x-wav", "audio/mp4", "audio/x-m4a", "audio/ogg", "audio/opus", "audio/x-opus"]
      },
      "fileSize": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 20971520
      },
      "kind": {
        "default": "voice_sample",
        "type": "string",
        "const": "voice_sample"
      },
      "requestId": {
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
        "type": "string",
        "format": "uuid",
        "pattern": "^[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}$"
      }
    },
    "required": ["filename", "contentType", "fileSize"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotenza

Usa un UUID v4 in requestId o nell'intestazione HTTP Idempotency-Key per ogni modifica. Riutilizza lo stesso identificatore e argomenti identici dopo un errore di rete. Se vengono forniti entrambi, devono coincidere. Ripetere una richiesta salvata non ripete l'operazione e non consuma un'altra chiamata mensile. Le richieste non riuscite o interrotte non vengono riavviate automaticamente.

Ogni modifica può restituire HTTP 202 quando un nuovo tentativo trova la stessa richiesta ancora in esecuzione, anche se la prima esecuzione è normalmente sincrona. Se l'esecuzione è completata ma resultStored è false, un nuovo tentativo restituisce HTTP 200 con lo stato della richiesta salvata anziché il risultato originale. Recupera l'output tramite l'azione di cronologia, risultato o download del relativo dominio.

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_initialize' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"filename":"voice-sample.wav","contentType":"audio/wav","fileSize":1048576,"kind":"voice_sample","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    filename: 'voice-sample.wav',
    contentType: 'audio/wav',
    fileSize: 1048576,
    kind: 'voice_sample',
    requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_initialize', {
    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/voices_upload_initialize",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"filename": "voice-sample.wav", "contentType": "audio/wav", "fileSize": 1048576, "kind": "voice_sample", "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

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

Sessione di caricamento multipart di proprietà dell'utente. key è un riferimento di archiviazione; completa tutte le parti prima di usarlo come fileKey di generazione.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
      "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
      "partSize": 5242880,
      "maxConcurrency": 4
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "operation": "voices_upload_initialize",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "operation": "voices_upload_initialize",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```
</ResponseExample>

## Campi del risultato

| Campo | Descrizione |
| - | - |
| `data.uploadId` | UUID opaco della sessione di caricamento attiva; usalo senza modificarlo nelle successive azioni multipart. |
| `data.key` | Chiave di archiviazione di proprietà del chiamante. Una generazione deve attendere upload\_complete. |
| `data.partSize` | Dimensioni in byte di ogni parte tranne l'ultima. |
| `data.maxConcurrency` | Numero massimo consigliato di parti caricate contemporaneamente. |

## Recupera e monitora questa richiesta

Usa lo stesso identificatore anche dopo una connessione persa. Se resultStored è false, recupera l'output tramite la corrispondente azione di cronologia, risultato o download. Non avviare mai una seconda generazione solo per verificarne l'avanzamento.

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"voices_upload_initialize"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "voices_upload_initialize",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
      "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
      "partSize": 5242880,
      "maxConcurrency": 4
    }
  }
}
```

## Note sull'operazione

* Richiede un abbonamento a pagamento e l'autorizzazione dell'azione. Il piano personale del chiamante per gli strumenti viene ricontrollato al momento dell'esecuzione; gli strumenti salvati e i riferimenti ai caricamenti appartengono a quel chiamante, anche quando la credenziale è associata a un team.
* Un'azione riuscita consuma una chiamata mensile condivisa API/MCP. Beginner consente 500, Starter 5,000 e Creator 25,000 chiamate al mese; Pro, Scale ed Enterprise non hanno un limite mensile. Si applicano comunque i limiti al minuto: rispettivamente 30, 60, 120, 180, 300 e 600. Le quote di generazione degli strumenti sono separate.
* Usa un requestId UUID v4, oppure un header Idempotency-Key identico, e mantieni la stessa azione, lo stesso ID e gli stessi argomenti nei tentativi successivi. La ripetizione di un risultato memorizzato nella cache non consuma un'altra chiamata mensile.
* Il prefisso di caricamento seleziona l'autorizzazione richiesta. tools utilizza transcription:write, subtitles utilizza subtitles:write, projects utilizza projects:write e voices utilizza voices:write.
* I campioni vocali supportano solo audio MP3, WAV, M4A, OGG o Opus e sono limitati a 20 MiB (20,971,520 byte). Il tipo MIME deve essere uno dei tipi audio documentati. kind ha come valore predefinito voice\_sample; questa famiglia non ha un'azione upload\_import.
* Usa il fileKey del campione completato con l'azione di creazione della voce pertinente. Il solo caricamento non crea una voce né genera audio vocale.
* Il nome del file in ingresso deve essere un singolo nome di file, senza barre, barre rovesciate, CR, LF o NUL. contentType deve essere un tipo MIME audio o video supportato, oppure application/octet-stream per i caricamenti non vocali.
* L'inizializzazione restituisce key, non fileKey. Conserva uploadId separatamente; è l'UUID usato per la firma, il completamento e l'interruzione.
* partSize viene selezionato tra 5 MiB e 100 MiB. Calcola il numero di parti come ceil(fileSize / partSize), usa al massimo maxConcurrency PUT simultanei e conserva ogni ETag restituito.
* Le sessioni di caricamento scadono dopo 24 ore. La preparazione del caricamento non consuma la quota giornaliera di generazioni.

## 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 | `BAD_REQUEST` | Il fileSize dichiarato supera il limite di caricamento del tipo selezionato o del piano. |
| 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 | `IDEMPOTENCY_CONFLICT` | Gli ID della richiesta nell'header e nel corpo sono diversi. |
| 400 | `INVALID_REQUEST_ID` | requestId o Idempotency-Key non è un UUID v4. |
| 400 | `VALIDATION_ERROR` | Gli argomenti non soddisfano lo schema dell'azione oppure è stato fornito un argomento sconosciuto. |
| 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 | `ACCOUNT_UNAVAILABLE` | L'account che esegue l'azione o quello di fatturazione non è disponibile o è in fase di eliminazione. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | L'utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo. |
| 403 | `INSUFFICIENT_SCOPE` | La chiave API o la connessione MCP non dispone dell'autorizzazione richiesta per l'azione. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Impossibile verificare i limiti di integrazione dell'account. |
| 403 | `PAID_SUBSCRIPTION_REQUIRED` | L'utente autenticato non dispone più di un abbonamento a pagamento quando questa azione dello strumento viene eseguita. |
| 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. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Questo account ha già 10 azioni di integrazione in esecuzione. Interroga una richiesta esistente prima di avviarne un'altra. |
| 409 | `IDEMPOTENCY_CONFLICT` | Riutilizza un identificatore solo con la stessa operazione e gli stessi argomenti. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Le chiamate utilizzate e in attesa hanno raggiunto la quota mensile API/MCP condivisa. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | L'account ha raggiunto il limite di integrazione al minuto; controlla retryAfterSeconds. |
| 500 | `INTERNAL_ERROR` | Controlla lo stato della richiesta salvata e la cronologia delle risorse prima di decidere se ripetere una modifica. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | L'azione è stata eseguita, ma non è stato possibile confermare la memorizzazione del risultato della richiesta. Interroga periodicamente la stessa azione con lo stesso requestId e controlla la cronologia della risorsa prima di avviare un'altra scrittura. |
| 503 | `INTERNAL_ERROR` | L'inizializzazione del caricamento o la memorizzazione durevole della sessione non è disponibile. |
| 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": ["voices:write"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.