> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get a language work

> Get language work metadata, pending segment indexes and normalized output versions.

Get language work metadata, pending segment indexes and normalized output versions.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/translations_get
```

## Authentication and permissions

**x-api-key** `string` *required*

Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
MCP, not by this REST endpoint.

Required permissions: `projects:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

**projectId** `string` *required*

Text value.

Minimum length: 1. Maximum length: 200. Pattern: `^[^/\\]+$`.

**workId** `string` *required*

Text value.

Minimum length: 1. Maximum length: 200. Pattern: `^[^/\\]+$`.

> [accordion] Complete input schema
>
> The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "projectId": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 200,
>       "pattern": "^[^/\\\\]+$"
>     },
>     "workId": {
>       "type": "string",
>       "minLength": 1,
>       "maxLength": 200,
>       "pattern": "^[^/\\\\]+$"
>     }
>   },
>   "required": ["projectId", "workId"],
>   "additionalProperties": false
> }
> ```

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/translations_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"projectId":"project_launch_2026","workId":"5f8423d1-e4c0-4f80-9e3f-eed959389e24"}'
```

```javascript JavaScript theme={null}
const input = {
  projectId: 'project_launch_2026',
  workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/translations_get', {
  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);
```

```python Python theme={null}
import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/translations_get",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

Returns one authorized language-work projection and its public versions.

```json HTTP 200 theme={null}
{
  "data": {
    "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
    "projectId": "project_launch_2026",
    "targetLanguage": "english",
    "originalLanguage": "fr",
    "createdAt": 1792152000000,
    "isWorkWaitingForProofreading": false,
    "pendingSegmentIndexes": [],
    "versions": [
      {
        "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
        "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
        "targetLanguage": "english",
        "status": "completed",
        "currentStep": "done",
        "progress": 100,
        "createdAt": 1792152060000,
        "completedAt": 1792152300000,
        "translatedVideoUrl": "https://media.example.com/launch/english.mp4",
        "translatedAudioUrl": "https://media.example.com/launch/english.mp3",
        "settings": {
          "voiceCloning": true,
          "uploadType": "video",
          "keepBackgroundMusic": true,
          "keepOriginalVoice": false,
          "originalVoiceVolume": 30,
          "subtitles": {
            "isEnable": false,
            "source": "translated"
          },
          "smartSync": true,
          "dubbingMode": "translate",
          "voiceIsolatorOption": "realistic"
        }
      }
    ]
  }
}
```

## Result fields

| Field | Description |
| - | - |
| `data.workId` | Language-work identifier. |
| `data.projectId` | Parent project identifier. |
| `data.targetLanguage` | Target language. |
| `data.originalLanguage` | Source language. |
| `data.createdAt` | Language-work creation time normalized to Unix milliseconds. |
| `data.isWorkWaitingForProofreading` | Proofreading state; false when not explicitly set. |
| `data.pendingSegmentIndexes` | Source segment indexes still pending translation, default empty array. |
| `data.versions` | All public versions in this work, sorted newest first. |
| `data.versions[].workId` | Language-work identifier containing this version. |
| `data.versions[].translatedVersionId` | Identifier for a particular dubbing output version. |
| `data.versions[].targetLanguage` | The version target language, falling back to its language work. |
| `data.versions[].status` | Stored version state: not-started, in-progress, completed, or failed. |
| `data.versions[].currentStep` | Optional dubbing pipeline step; progress is an optional numeric progress value. |
| `data.versions[].progress` | Optional dubbing progress value. |
| `data.versions[].createdAt` | Creation time normalized to Unix milliseconds; falls back to language-work creation time. |
| `data.versions[].completedAt` | Optional completion time in Unix milliseconds. |
| `data.versions[].failedAt` | Optional failure time in Unix milliseconds. |
| `data.versions[].timedOutAt` | Optional timeout time in Unix milliseconds. |
| `data.versions[].translatedVideoUrl` | Stored translated video URL, or an empty string when unavailable. |
| `data.versions[].translatedAudioUrl` | Stored translated audio URL, or an empty string when unavailable. |
| `data.versions[].error` | Optional \{code,message} when the version failed. |
| `data.versions[].settings` | Public version settings: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption, and optional translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
| `data.versions[].settings.dubbingMode` | translate or dub-only. SmartSync is false for dub-only versions. |
| `data.versions[].lipSync` | Optional \{latest,history}; each entry has jobId, status, videoUrl, errorMessage, type, createdAt, and optional requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Lip-sync times are stored ISO strings. |
| `data.versions[].dynamicSubtitles` | Optional object with used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage, and optional removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt is Unix milliseconds. |
| `data.versions[].publicationAttempts` | Optional array of public publication attempts: id, status, origin, plus optional scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
| `data.versions[].publishedVideos` | Optional array with type, videoId, privacyStatus and optional url, datePublished, origin, scheduledAt, plannedPublicationId. |

## Operation notes

* workId must belong to projectId and have the same stored project owner.
* pendingSegmentIndexes lists text still needing translation; it is separate from the segment action queue.
* Stored failures return VoiceCheap error codes and fixed messages. Use the code and current resource state to decide how to recover.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | Correct the input using the schema. Invalid or inconsistent values are rejected before execution. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `FORBIDDEN` | The authenticated actor cannot access this project. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `PROJECT_NOT_FOUND` | The project does not exist in the accessible account. |
| 404 | `TRANSLATION_NOT_FOUND` | workId does not identify a language work owned by this project. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["projects:read"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.