---
title: "Create Proofread Session"
method: POST
path: "/v3/video-translations/proofreads"
tags: ["Video Translate"]
---

# Create Proofread Session

`POST /v3/video-translations/proofreads`

Creates a proofread session that extracts editable subtitles from a video before final rendering.

## Headers

- `Idempotency-Key` string

## Request body

- CreateProofreadRequest — Request body for POST /v3/video-translations/proofreads.
  - `video` union, required — Source video — provide as {type: 'url', url: '...'} or {type: 'asset_id', asset_id: '...'}
    - AssetUrl — Asset input via publicly accessible HTTPS URL.
      - `type` 'url', required — Input type discriminator
      - `url` string, required — Publicly accessible HTTPS URL for the asset
    - AssetId — Asset input via HeyGen asset ID from the asset upload endpoint.
      - `type` 'asset_id', required — Input type discriminator
      - `asset_id` string, required — HeyGen asset ID from the asset upload endpoint
  - `output_languages` string[], required — Target language codes. Use one for single proofread, multiple for batch.
  - `title` string, required — Title for the proofread job
  - `brand_voice_id` string, nullable — Brand glossary ID for custom term translations. Legacy field name for `brand_glossary_id` — both are accepted and resolve to the same workspace record. Discover IDs via GET /v3/brand-glossaries.
  - `brand_glossary_id` string, nullable — Brand glossary ID for custom term translations (e.g. translate 'Reformer' as 'Pilates equipment', not 'political activist'). Alias for the legacy `brand_voice_id` field. Discover IDs via GET /v3/brand-glossaries.
  - `speaker_num` integer, nullable — Number of speakers (improves speaker separation)
  - `folder_id` string, nullable — Project/folder ID to organize proofread into
  - `enable_video_stretching` boolean — Allow dynamic duration adjustment
  - `disable_music_track` boolean — Remove background music
  - `enable_speech_enhancement` boolean — Enhance speech quality
  - `srt` union — Initial SRT file — provide as {type: 'url', url: '...'} or {type: 'asset_id', asset_id: '...'}
    - AssetUrl — Asset input via publicly accessible HTTPS URL.
      - `type` 'url', required — Input type discriminator
      - `url` string, required — Publicly accessible HTTPS URL for the asset
    - AssetId — Asset input via HeyGen asset ID from the asset upload endpoint.
      - `type` 'asset_id', required — Input type discriminator
      - `asset_id` string, required — HeyGen asset ID from the asset upload endpoint
  - `mode` 'speed' | 'precision'
  - `keep_the_same_format` boolean — Preserve the source video's encoding specs (resolution, bitrate)

## Response `200`

Successful response

- object
  - `data` CreateProofreadResponse — Response for POST /v3/video-translations/proofreads.
    - `proofread_ids` string[], required — Proofread IDs, one per target language
    - `status` 'processing' | 'completed' | 'failed', required

## Other responses

- `400` — Invalid request parameters
- `401` — Authentication failed
- `409` — A prior request with this Idempotency-Key is still in progress. Wait for the original request to complete, then retry.
- `429` — Rate limit exceeded

---

[API](https://skmtc.net/heygen/apis/heygen-external-api.md) · [All operations](https://skmtc.net/heygen/apis/heygen-external-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/heygen/heygen-external-api/revisions/e2e54726e210/schema)