Export a saved transcription action result

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

​

Authentication and permissions

​

Parameters

{
  "type": "object",
  "properties": {
    "resultId": {
      "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)$"
    }
  },
  "required": ["resultId"],
  "additionalProperties": false
}

​

Request examples

curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_download' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'

const input = {
  resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_download', {
  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/transcription_result_download",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)

​

Response

{
  "data": {
    "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
    "operation": "transcription_create",
    "createdAt": 1792152000000,
    "fileName": "voicecheap-transcription_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
    "byteLength": 116,
    "contentType": "application/json; charset=utf-8",
    "status": "completed",
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "getAction": "transcription_result_get",
    "downloadAction": "transcription_result_download",
    "listAction": "transcription_result_list",
    "content": "{\"transcript\":{\"raw\":\"Hello world.\",\"paragraphs\":\"Hello world.\",\"sentences\":\"Hello world.\",\"detectedLanguage\":\"en\"}}"
  }
}

​

Result fields

​

Operation notes

• Requires a paid subscription and the action permission. The actor’s personal tool plan is rechecked at execution; saved tools and upload references belong to that actor, including when the credential is associated with a team.
• A successful action uses one shared monthly API/MCP call. Beginner allows 500, Starter 5,000 and Creator 25,000 calls/month; Pro, Scale and Enterprise have no monthly ceiling. Per-minute limits still apply: 30, 60, 120, 180, 300 and 600 respectively. Tool generation allowances are separate.
• resultId is a UUID from a completed generation reference or this domain’s result_list. It is different from the action requestId and web-tool historyId.
• Results are owned by the authenticated actor and permission domain. A subtitles result cannot be read through transcription actions, or the reverse.
• Complete saved JSON is encrypted at rest and retained independently of the bounded action polling cache. Retrieval remains authenticated; no public transcript or caption JSON URL is issued.
• These actions retrieve existing output and do not generate media or use a daily allowance. Each successful retrieval still uses one monthly integration call.
• Pending metadata means output persistence needs recovery. Reading content or downloading attempts recovery of an already saved encrypted object; check it before starting another generation.
• Write content to fileName using UTF-8, or JSON.parse(content) to recover the structured output. The outer response does not contain a result property or a media download URL.
• byteLength describes the UTF-8 JSON inside content; contentType is application/json; charset=utf-8. Download also attempts recovery of pending encrypted output.

​

Usage

​

Errors

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