Skip to main content
POST
Get language work metadata, pending segment indexes and normalized output versions.

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.
Required permissions: 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: ^[^/\\]+$.
string
required
Text value.Minimum length: 1. Maximum length: 200. Pattern: ^[^/\\]+$.
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.

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.

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.

Result fields

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