Get Filler Word Removal

Returns the job resource: lifecycle status, progress, and — once completed — the presigned download URL of the cleaned video plus removal statistics (num_cuts, reduction_pct, durations).

GET /v3/filler-word-removals/{filler_word_removal_id}

Get Filler Word Removal

cURL

curl --request GET \
  --url https://api.heygen.com/v3/filler-word-removals/{filler_word_removal_id} \
  --header 'x-api-key: <api-key>'

import requests

url = "https://api.heygen.com/v3/filler-word-removals/{filler_word_removal_id}"

headers = {"x-api-key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.heygen.com/v3/filler-word-removals/{filler_word_removal_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.heygen.com/v3/filler-word-removals/{filler_word_removal_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.heygen.com/v3/filler-word-removals/{filler_word_removal_id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.heygen.com/v3/filler-word-removals/{filler_word_removal_id}")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.heygen.com/v3/filler-word-removals/{filler_word_removal_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

200

{
  "data": {
    "id": "<string>",
    "title": "<string>",
    "progress": 0,
    "video_url": "<string>",
    "thumbnail_url": "<string>",
    "original_duration": 123,
    "output_duration": 123,
    "num_cuts": 123,
    "reduction_pct": 123,
    "callback_id": "<string>",
    "created_at": 123,
    "failure_message": "<string>"
  }
}

{
  "error": {
    "code": "invalid_parameter",
    "message": "Video not found",
    "param": "<string>",
    "doc_url": "<string>"
  }
}

{
  "error": {
    "code": "authentication_failed",
    "message": "Invalid or expired API key. Verify your x-api-key header.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "not_found",
    "message": "Filler word removal job not found.",
    "param": null,
    "doc_url": null
  }
}

{
  "error": {
    "code": "rate_limit_exceeded",
    "message": "Too many requests. Retry after the duration specified in the Retry-After header.",
    "param": null,
    "doc_url": null
  }
}

Authorizations

ApiKeyAuthBearerAuth

x-api-key · string · header · required

HeyGen API key. Obtain from your HeyGen dashboard.

Path Parameters

filler_word_removal_id · string · required

Unique filler word removal job identifier

Response

200

application/json

Successful response

data · FillerWordRemovalDetail · object

Full job resource returned by GET /v3/filler-word-removals/{id}.

Invariant: status=completed always carries a video_url — when the run changes nothing (no filler cuts and no silence trims) the output is a byte-copy of the original and the charge is auto-refunded, so polling scripts never need a special no-op branch. Note num_cuts counts filler segments only; a run may report num_cuts=0 yet still be billed when it trimmed long silences (reduction_pct > 0).

Show child attributes