curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_status' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_status', {
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/projects_status",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"projectName": "Product launch",
"originalVideoUrl": "https://media.example.com/launch/original.mp4",
"originalLanguage": "fr",
"targetLanguage": "english",
"duration": 75,
"createdAt": 1792152000000,
"workflow": "translation",
"transcriptionStatus": "success",
"actualProgressStep": "done",
"translationAndTranscriptionProgress": 100,
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"dubbingStep": "done",
"dubbingProgress": 100,
"status": "success",
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3"
}
}
Projects
Get project processing status
Poll transcription, translation and lip-sync progress and retrieve completed output URLs.
POST
/
v1
/
actions
/
projects_status
curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_status' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_status', {
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/projects_status",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"projectName": "Product launch",
"originalVideoUrl": "https://media.example.com/launch/original.mp4",
"originalLanguage": "fr",
"targetLanguage": "english",
"duration": 75,
"createdAt": 1792152000000,
"workflow": "translation",
"transcriptionStatus": "success",
"actualProgressStep": "done",
"translationAndTranscriptionProgress": 100,
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"dubbingStep": "done",
"dubbingProgress": 100,
"status": "success",
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3"
}
}
Poll transcription, translation and lip-sync progress and retrieve completed output URLs.
Required permissions:
POST https://api.voicecheap.ai/v1/actions/projects_status
Authentication and permissions
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.
projects:read.
An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.
Parameters
string
required
Text value.Minimum length: 1. Maximum length: 200. Pattern:
^[^/\\]+$.Complete input schema
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.
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"required": ["projectId"],
"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.curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_status' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_status', {
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/projects_status",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
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 processing progress and completed output URLs without embedded transcripts.{
"data": {
"projectId": "project_launch_2026",
"projectName": "Product launch",
"originalVideoUrl": "https://media.example.com/launch/original.mp4",
"originalLanguage": "fr",
"targetLanguage": "english",
"duration": 75,
"createdAt": 1792152000000,
"workflow": "translation",
"transcriptionStatus": "success",
"actualProgressStep": "done",
"translationAndTranscriptionProgress": 100,
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"dubbingStep": "done",
"dubbingProgress": 100,
"status": "success",
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3"
}
}
Result fields
| Field | Description |
|---|---|
data.projectId | Parent project identifier. |
data.projectName | Project name. |
data.originalVideoUrl | Original stored media URL or empty string. |
data.originalLanguage | Source language or unknown. |
data.targetLanguage | The first configured project target language, default english; this is not a list of all language works. |
data.duration | Media duration in seconds. |
data.createdAt | Project creation time in Unix milliseconds. |
data.workflow | transcription or translation. |
data.transcriptionStatus | processing, success, or failed. |
data.actualProgressStep | Current project step, replaced with the dubbing step when transcription is done and dubbing remains active. |
data.translationAndTranscriptionProgress | Optional stored transcription progress. |
data.status | processing, success, or failed for the current workflow. |
data.workId | Present when a latest translated version exists in the newest language work. |
data.translatedVersionId | Latest version identifier in the newest language work. |
data.dubbingStep | Optional dubbing step from that version. |
data.dubbingProgress | Optional dubbing progress from that version. |
data.translatedVideoUrl | Included for a successful completed version when a video URL exists. |
data.translatedAudioUrl | Included for a successful completed version; an empty string when no audio URL is stored. |
data.lipSync | Optional most recent lip-sync entry with jobId, status, videoUrl, errorMessage, public type, createdAt and optional requestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled. |
data.error | Optional public {code,message} when project processing, translation, or lip sync failed. |
Operation notes
- Use this action to poll projects_create, translations_create, translations_start, translations_dub, and lipsync_create. Fetch transcripts separately with transcripts_get.
- This authenticated, rate-limited status read does not spend the monthly action-call allowance.
- For translations it follows the most recently created language work and its last version. For full multi-language state, read projects_get or translations_list.
- A transcription-only project succeeds when transcription finishes. A completed dubbed output can remain processing while lip sync is active, or failed if its latest lip sync failed.
- The handler always removes transcripts from the underlying status result. It has no dynamic-subtitle completion fields; poll projects_get for those.
- Stored failures return VoiceCheap error codes and fixed messages. Use the code and current resource state to decide how to recover.
Usage
This status or usage control does not consume the monthly API/MCP call allowance. Authentication, paid access, ownership, and rate limits still 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. |
| 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. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["projects:read"]
}
}
Was this page helpful?