Een media-upload starten (transcriptie)

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

​

Authenticatie en machtigingen

​

Parameters

{
  "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
}

​

Idempotentie

​

Voorbeeldaanvragen

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)

​

Antwoord

{
  "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"
}

​

Resultaatvelden

​

Deze aanvraag herstellen en controleren

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
    }
  }
}

​

Opmerkingen bij de bewerking

• Vereist een betaald abonnement en de actiemachtiging. Het persoonlijke toolabonnement van de uitvoerende gebruiker wordt bij uitvoering opnieuw gecontroleerd; opgeslagen tools en uploadreferenties behoren toe aan die gebruiker, ook wanneer het toegangsmiddel aan een team is gekoppeld.
• Een geslaagde actie verbruikt één gedeelde maandelijkse API/MCP-aanroep. Beginner staat 500, Starter 5,000 en Creator 25,000 aanroepen/maand toe; Pro, Scale en Enterprise hebben geen maandelijkse bovengrens. De limieten per minuut blijven gelden: respectievelijk 30, 60, 120, 180, 300 en 600. Tegoeden voor toolgeneraties staan hier los van.
• Gebruik een UUID v4 voor requestId of een identieke Idempotency-Key-header en behoud dezelfde actie, ID en argumenten bij nieuwe pogingen. Een herhaling uit de cache verbruikt geen extra maandelijkse aanroep.
• Het uploadvoorvoegsel bepaalt het vereiste recht. tools gebruikt transcription:write, subtitles gebruikt subtitles:write, projects gebruikt projects:write en voices gebruikt voices:write.
• Voor tools, subtitles en projects accepteert kind de waarden transcription, video_to_srt, add_subtitles, animated_captions of project. De geselecteerde waarde van kind bepaalt de workflowlimieten; het voorvoegsel dwingt geen waarde voor kind af.
• De gekozen waarde van kind hanteert eigen limieten: transcription 200 MiB; video_to_srt en add_subtitles 300 MiB; animated_captions 250 MiB en alleen audio; project gebruikt de uploadlimiet van het abonnement (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). Losse media duren maximaal 2 uur. Ondertiteling staat 30 minuten toe op Beginner en 60 minuten op hogere openbare abonnementen, plus een containertolerantie van 2 seconden. De projectduur is maximaal 2 uur, of 3 uur op Enterprise.
• De invoerbestandsnaam moet één bestandsnaam zijn, zonder slashes, backslashes, CR, LF of NUL. De contentType moet een ondersteund audio-/video-MIME-type zijn, of application/octet-stream voor andere uploads dan stemuploads.
• Initialisatie retourneert key, geen fileKey. Bewaar uploadId afzonderlijk; dit is de UUID die wordt gebruikt voor ondertekening, voltooiing en afbreken.
• partSize wordt gekozen van 5 MiB tot 100 MiB. Bereken het aantal delen als ceil(fileSize / partSize), gebruik maximaal maxConcurrency gelijktijdige PUTs en bewaar elke geretourneerde ETag.
• Uploadsessies verlopen na 24 uur. Het voorbereiden van een upload telt niet mee voor de dagelijkse generatielimiet.

​

Verbruik

​

Fouten

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