Rozpocznij przesyłanie multimediów (napisy)

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

​

Uwierzytelnianie i uprawnienia

​

Parametry

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

​

Idempotencja

​

Przykłady żądań

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

const input = {
  filename: 'interview.mp4',
  contentType: 'video/mp4',
  fileSize: 1048576,
  kind: 'video_to_srt',
  requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_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/subtitles_upload_initialize",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"filename": "interview.mp4", "contentType": "video/mp4", "fileSize": 1048576, "kind": "video_to_srt", "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)

​

Odpowiedź

{
  "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": "subtitles_upload_initialize",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}

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

​

Pola wyniku

​

Odzyskaj żądanie i sprawdź jego stan

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

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

​

Uwagi do operacji

• Wymaga płatnej subskrypcji i uprawnienia do akcji. Osobisty plan narzędzi użytkownika wykonującego żądanie jest ponownie sprawdzany podczas wykonywania; zapisane narzędzia i referencje przesłanych plików należą do tego użytkownika, również gdy dane uwierzytelniające są powiązane z zespołem.
• Pomyślna akcja zużywa jedno wspólne miesięczne wywołanie API/MCP. Beginner pozwala na 500, Starter na 5,000, a Creator na 25,000 wywołań miesięcznie; Pro, Scale i Enterprise nie mają miesięcznego limitu. Nadal obowiązują limity na minutę: odpowiednio 30, 60, 120, 180, 300 i 600. Limity generowania narzędzi są odrębne.
• Użyj requestId w formacie UUID v4 lub identycznego nagłówka Idempotency-Key i przy ponawianiu zachowuj tę samą akcję, identyfikator i argumenty. Odtworzenie zapisanej odpowiedzi nie zużywa kolejnego miesięcznego wywołania.
• Prefiks przesyłania określa wymagane uprawnienie. tools używa transcription:write, subtitles używa subtitles:write, projects używa projects:write, a voices używa voices:write.
• Dla narzędzi, napisów i projektów kind przyjmuje transcription, video_to_srt, add_subtitles, animated_captions lub project. Wybrane kind określa limity procesu; prefiks nie wymusza kind.
• Wybrane kind stosuje własne limity: transcription 200 MiB; video_to_srt i add_subtitles 300 MiB; animated_captions 250 MiB i wyłącznie audio; project stosuje limit przesyłania z planu (Beginner 5 GiB, Starter 10 GiB, Creator 20 GiB, Pro 30 GiB, Scale 40 GiB, Enterprise 60 GiB). Samodzielne multimedia mogą trwać maksymalnie 2 godziny. Napisy dopuszczają 30 minut w planie Beginner i 60 minut w wyższych planach publicznych, z dodatkową tolerancją kontenera wynoszącą 2 sekundy. Projekt może trwać maksymalnie 2 godziny lub 3 godziny w planie Enterprise.
• Wejściowa nazwa pliku musi być pojedynczą nazwą pliku, bez ukośników, ukośników odwrotnych, CR, LF ani NUL. contentType musi być obsługiwanym typem MIME audio lub wideo albo application/octet-stream dla przesyłania innego niż głosowe.
• Inicjalizacja zwraca key, a nie fileKey. Zachowaj uploadId osobno; to UUID używany do podpisywania, ukończenia i przerwania.
• partSize jest wybierane z zakresu od 5 MiB do 100 MiB. Oblicz liczbę części jako ceil(fileSize / partSize), używaj najwyżej maxConcurrency równoczesnych żądań PUT i zachowaj każdy zwrócony ETag.
• Sesje przesyłania wygasają po 24 godzinach. Przygotowanie przesyłania nie zużywa dziennego limitu generowania.

​

Wykorzystanie

​

Błędy

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