> ## 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.

# Edit a transcript segment

> Queue an original or translated text edit. requestId must be a stable UUID for retries. Poll segment_actions_list for completion.

Queue an original or translated text edit. requestId must be a stable UUID for retries. Poll segment\_actions\_list for completion.

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

## Authentication and permissions

<ParamField header="x-api-key" type="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.
</ParamField>

Required permissions: `transcription:write`.

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

## Parameters

<ParamField body="projectId" type="string" required>
  Text value.

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

<ParamField body="segmentIndex" type="integer" required>
  Integer value.

  Minimum: 0. Maximum: 9007199254740991.
</ParamField>

<ParamField body="requestId" type="string">
  Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.

  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}$`.
</ParamField>

<ParamField body="source" type="string" required>
  Text value.

  Allowed values: "original", "translated".
</ParamField>

<ParamField body="workId" type="string">
  Text value.

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

<ParamField body="text" type="string" required>
  Text value.

  Maximum length: 3000.
</ParamField>

<ParamField body="enableEditing" type="boolean">
  Boolean value.
</ParamField>

<Accordion title="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": "^[^/\\\\]+$"
      },
      "segmentIndex": {
        "type": "integer",
        "minimum": 0,
        "maximum": 9007199254740991
      },
      "requestId": {
        "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}$",
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
      },
      "source": {
        "type": "string",
        "enum": ["original", "translated"]
      },
      "workId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      },
      "text": {
        "type": "string",
        "maxLength": 3000
      },
      "enableEditing": {
        "type": "boolean"
      }
    },
    "required": ["projectId", "segmentIndex", "source", "text"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically.

Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

## 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.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/segments_text_update' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026","segmentIndex":0,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991","source":"original","text":"Bienvenue au lancement de VoiceCheap."}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
    segmentIndex: 0,
    requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
    source: 'original',
    text: 'Bienvenue au lancement de VoiceCheap.',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/segments_text_update', {
    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/segments_text_update",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026", "segmentIndex": 0, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "source": "original", "text": "Bienvenue au lancement de VoiceCheap."},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 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 queue admission plus a fresh queue snapshot for an original or translated text edit.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "status": "queued",
      "jobId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "queue": {
        "projectId": "project_launch_2026",
        "revision": 1,
        "items": [
          {
            "id": "41321bda-e243-4b6f-96a4-622cd047c991",
            "action": {
              "type": "text",
              "segmentIndex": 0,
              "source": "original"
            },
            "status": "queued",
            "createdAt": 1792152000000
          }
        ]
      }
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "operation": "segments_text_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "operation": "segments_text_update",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```
</ResponseExample>

## Result fields

| Field | Description |
| - | - |
| `data.status` | started when this job was claimed or has begun; queued otherwise. Neither value means completion. |
| `data.jobId` | Queue job identifier, equal to the stable submission requestId. |
| `data.queue` | Fresh project queue snapshot, which may already show the job running or terminal. |
| `data.queue.projectId` | Parent project identifier. |
| `data.queue.revision` | Queue snapshot revision. This is independent of projects\_get.segmentStructureRevision. |
| `data.queue.items` | Project action progress: job identifiers, action metadata, state, timestamps and optional public errorCode. |
| `data.queue.items[].id` | Job identifier; equals the original queue submission requestId. |
| `data.queue.items[].action` | Action metadata only: type, segmentIndex, and optional workId, translatedVersionId and source. Submitted text, timing values and regeneration instructions are not returned. |
| `data.queue.items[].status` | queued, running, completed, failed, or cancelled. |
| `data.queue.items[].createdAt` | Queue item creation time in Unix milliseconds. |
| `data.queue.items[].startedAt` | Optional first start time in Unix milliseconds. |
| `data.queue.items[].finishedAt` | Optional terminal time in Unix milliseconds. |
| `data.queue.items[].errorCode` | Optional public failure code. Unclassified failures use ACTION\_FAILED. |
| `data.queue.items[].seenAt` | Optional acknowledgement time for the authenticated viewer only. |

## Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.

```bash theme={null}
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":"41321bda-e243-4b6f-96a4-622cd047c991","operation":"segments_text_update"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
    "operation": "segments_text_update",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "status": "queued",
      "jobId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "queue": {
        "projectId": "project_launch_2026",
        "revision": 1,
        "items": [
          {
            "id": "41321bda-e243-4b6f-96a4-622cd047c991",
            "action": {
              "type": "text",
              "segmentIndex": 0,
              "source": "original"
            },
            "status": "queued",
            "createdAt": 1792152000000
          }
        ]
      }
    }
  }
}
```

## Operation notes

* Use one UUID v4 requestId for the intended edit and reuse it with identical arguments on retries. jobId equals this requestId.
* Admission returns started or queued, not completion. Poll segment\_actions\_list and find items\[].id equal to jobId until completed, failed, or cancelled, then refresh transcripts\_get and projects\_get.
* queue.revision tracks queue state; it is not a source segment structure revision. Queue actions capture the current structure when admitted. A later incompatible structure change can fail the item with SEGMENT\_STRUCTURE\_CHANGED.
* Only one pending action for the same logical segment target is admitted. A new requestId does not bypass SEGMENT\_ACTION\_ALREADY\_PENDING.
* Queue execution failures appear as items\[].status failed plus errorCode, rather than changing the successful submission result.
* For original edits omit workId and enableEditing. Original text edits mark that segment pending translation in every language work; they do not automatically generate new speech.
* For translated edits use source translated and supply workId. Both transcription:write and translations:write permissions are required.
* enableEditing is allowed only for translated edits and explicitly toggles manual translation mode. A translated edit updates text and editing state without regenerating its speech.
* An empty text string is allowed by the action schema. Use dedicated segments\_delete to remove a segment and keep all languages aligned.
* Queue responses, including submission, cancellation, polling and replay, contain action metadata only. Read transcript content with transcripts\_get and the required transcription:read permission.

## 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 | `BAD_REQUEST` | The source segment index does not exist or the queue arguments are invalid. |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `IDEMPOTENCY_CONFLICT` | The Idempotency-Key header and requestId body field must match. |
| 400 | `INVALID_REQUEST_ID` | Supply a UUID v4 requestId or Idempotency-Key. |
| 400 | `SEGMENT_QUEUE_FULL` | The project already has 50 pending segment actions. |
| 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 | `ACCOUNT_UNAVAILABLE` | The acting or billing account is unavailable or being deleted. |
| 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` | Translated text editing additionally requires translations:write. |
| 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` | The translated edit work does not belong to this project. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | This account already has 10 integration actions running. Poll an existing request before starting another. |
| 409 | `IDEMPOTENCY_CONFLICT` | Reuse an identifier only with the same operation and arguments. |
| 409 | `SEGMENT_ACTION_ALREADY_PENDING` | An action for the same logical segment target is already queued or running. |
| 409 | `SEGMENT_STRUCTURE_BUSY` | A segment structure mutation is active; reload the project before submitting again. |
| 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 | `ACTION_RESULT_UNAVAILABLE` | The action ran but its result could not be saved. Inspect saved request state and resource history before starting a new generation. |
| 503 | `INTERNAL_ERROR` | The segment queue is disabled on the development server; the action was not admitted. |
| 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": ["transcription:write"]
  }
}
```


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