Completa un caricamento multimediale (trascrizione)

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

​

Autenticazione e autorizzazioni

​

Parametri

{
  "type": "object",
  "properties": {
    "uploadId": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([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)$"
    },
    "parts": {
      "minItems": 1,
      "maxItems": 10000,
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "partNumber": {
            "type": "integer",
            "minimum": 1,
            "maximum": 10000
          },
          "etag": {
            "type": "string",
            "minLength": 1,
            "maxLength": 512,
            "pattern": "^[^\\r\\n]+$"
          }
        },
        "required": ["partNumber", "etag"],
        "additionalProperties": false
      }
    },
    "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": ["uploadId", "parts"],
  "additionalProperties": false
}

​

Idempotenza

​

Esempi di richiesta

curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_complete' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","parts":[{"partNumber":1,"etag":"0123456789abcdef0123456789abcdef"}],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
  parts: [
    {
      partNumber: 1,
      etag: '0123456789abcdef0123456789abcdef',
    },
  ],
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_complete', {
  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/tools_upload_complete",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "parts": [{"partNumber": 1, "etag": "0123456789abcdef0123456789abcdef"}], "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)

​

Risposta

{
  "data": {
    "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
    "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_complete",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_complete",
    "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"
}

​

Campi del risultato

​

Recupera e monitora questa richiesta

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":"tools_upload_complete"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_upload_complete",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
      "readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
    }
  }
}

​

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.
• Per strumenti, sottotitoli e progetti, kind accetta transcription, video_to_srt, add_subtitles, animated_captions o project. Il kind selezionato determina i limiti del flusso di lavoro; il prefisso non impone un kind.
• Il kind scelto applica i propri limiti: transcription 200 MiB; video_to_srt e add_subtitles 300 MiB; animated_captions 250 MiB e solo audio; project usa il limite di caricamento del piano (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). I contenuti multimediali autonomi durano al massimo 2 ore. I sottotitoli consentono 30 minuti su Beginner e 60 minuti sui piani pubblici superiori, più una tolleranza del contenitore di 2 secondi. La durata del progetto è al massimo di 2 ore, o 3 ore su Enterprise.
• Invia ogni parte caricata esattamente una volta con l’ETag restituito dal relativo PUT. Le parti vengono ordinate per partNumber prima della finalizzazione; gli ETag possono includere o meno le virgolette esterne.
• Un completamento riuscito rimuove la sessione attiva. Riutilizza lo stesso requestId per recuperare il risultato dopo la perdita di una risposta; non inviare un nuovo completamento per la sessione già consumata.
• Completare un caricamento non consuma la quota giornaliera di generazioni. La generazione separata determina l’utilizzo multimediale.

​

Utilizzo

​

Errori

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