Medienupload initialisieren (Transkription)

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

​

Authentifizierung und Berechtigungen

​

Parameter

{
  "type": "object",
  "properties": {
    "filename": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255,
      "pattern": "^[^/\\\\\\r\\n\\0]+$"
    },
    "contentType": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120,
      "pattern": "^(audio|video)\\/[A-Za-z0-9.+-]+$|^application\\/octet-stream$"
    },
    "fileSize": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 64424509440
    },
    "kind": {
      "type": "string",
      "enum": ["transcription", "video_to_srt", "add_subtitles", "animated_captions", "project"]
    },
    "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", "kind"],
  "additionalProperties": false
}

​

Idempotenz

​

Anfragebeispiele

curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_initialize' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"filename":"interview.mp4","contentType":"video/mp4","fileSize":1048576,"kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'

const input = {
  filename: 'interview.mp4',
  contentType: 'video/mp4',
  fileSize: 1048576,
  kind: 'transcription',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_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);

import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/tools_upload_initialize",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"filename": "interview.mp4", "contentType": "video/mp4", "fileSize": 1048576, "kind": "transcription", "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)

​

Antwort

{
  "data": {
    "uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678",
    "key": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
    "partSize": 5242880,
    "maxConcurrency": 4
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

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

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

​

Ergebnisfelder

​

Diese Anfrage wiederherstellen und abfragen

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_initialize"}'

{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "tools_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-interview.mp4",
      "partSize": 5242880,
      "maxConcurrency": 4
    }
  }
}

​

Hinweise zur Operation

• Erfordert ein kostenpflichtiges Abonnement und die Aktionsberechtigung. Der persönliche Tooltarif des handelnden Kontos wird bei der Ausführung erneut geprüft; gespeicherte Tools und Uploadreferenzen gehören diesem Konto, auch wenn die Zugangsdaten einem Team zugeordnet sind.
• Eine erfolgreiche Aktion verbraucht einen gemeinsamen monatlichen API/MCP-Aufruf. Beginner erlaubt 500, Starter 5,000 und Creator 25,000 Aufrufe/Monat; Pro, Scale und Enterprise haben keine monatliche Obergrenze. Limits pro Minute gelten weiterhin: jeweils 30, 60, 120, 180, 300 und 600. Generierungskontingente der Werkzeuge sind davon getrennt.
• Verwenden Sie eine UUID v4 als requestId oder einen identischen Idempotency-Key-Header und behalten Sie bei erneuten Versuchen dieselbe Aktion, ID und dieselben Argumente bei. Eine zwischengespeicherte Wiederholung verbraucht keinen weiteren monatlichen Aufruf.
• Das Upload-Präfix bestimmt die erforderliche Berechtigung. tools verwendet transcription:write, subtitles verwendet subtitles:write, projects verwendet projects:write und voices verwendet voices:write.
• Für Tools, Untertitel und Projekte akzeptiert kind die Werte transcription, video_to_srt, add_subtitles, animated_captions oder project. Der ausgewählte kind-Wert bestimmt die Grenzwerte des Ablaufs; das Präfix erzwingt keinen kind-Wert.
• Für den gewählten kind-Wert gelten eigene Grenzwerte: transcription 200 MiB; video_to_srt und add_subtitles 300 MiB; animated_captions 250 MiB und ausschließlich Audio; project verwendet das Upload-Limit des Tarifs (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). Eigenständige Medien dürfen höchstens 2 Stunden lang sein. Untertitel erlauben 30 Minuten bei Beginner und 60 Minuten bei höheren öffentlichen Tarifen, zuzüglich einer Containertoleranz von 2 Sekunden. Die Projektdauer beträgt höchstens 2 Stunden oder 3 Stunden bei Enterprise.
• Der eingegebene Dateiname muss ein einzelner Dateiname sein, ohne Schrägstriche, umgekehrte Schrägstriche, CR, LF oder NUL. contentType muss ein unterstützter Audio-/Video-MIME-Typ oder bei Nicht-Stimm-Uploads application/octet-stream sein.
• Die Initialisierung gibt key zurück, nicht fileKey. Bewahren Sie uploadId separat auf; dies ist die UUID für Signierung, Abschluss und Abbruch.
• partSize wird zwischen 5 MiB und 100 MiB gewählt. Berechnen Sie die Anzahl der Teile als ceil(fileSize / partSize), verwenden Sie höchstens maxConcurrency gleichzeitige PUTs und bewahren Sie jedes zurückgegebene ETag auf.
• Upload-Sitzungen laufen nach 24 Stunden ab. Die Upload-Vorbereitung verbraucht kein tägliches Generierungskontingent.

​

Nutzung

​

Fehler

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