> ## Documentation Index
> Fetch the complete documentation index at: https://heygen-1fa696a7.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Create Filler Word Removal

> Submit a video and return a job id immediately. The job runs asynchronously: it transcribes the audio, detects filler words ('um', 'uh', ...), removes them along with overlong silences, and renders one cleaned video — no review step. If the run changes nothing at all, the job completes with the original video as output and the charge is automatically refunded. Pricing: $0.60 per source minute, 1-minute minimum. Poll GET /v3/filler-word-removals/{id} or subscribe to filler_word_removal.success / filler_word_removal.fail webhooks.



## OpenAPI

````yaml /openapi/external-api.json post /v3/filler-word-removals
openapi: 3.1.0
info:
  title: HeyGen External API
  version: 1.0.0
  description: >-
    HeyGen's external API for programmatic AI video creation. See
    https://docs.heygen.com for full documentation.
  contact:
    name: HeyGen Product Infra
    url: https://heygen.com
servers:
  - url: https://api.heygen.com
    description: Production
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Video Agent
    description: Create videos from text prompts using AI
  - name: Videos
    description: Create, list, retrieve, and delete videos
  - name: Templates
    description: Generate videos from reusable templates by replacing their variables
  - name: Voices
    description: Text-to-speech and voice management
  - name: Audio
    description: Search the background-music and sound-effects catalog
  - name: Video Translate
    description: Translate videos into other languages
  - name: AI Clipping
    description: Turn long-form videos into ready-to-share short clips with captions
  - name: Batches
    description: Create and track batches of videos.
  - name: Video Translation Batches
    description: Create and track batches of video translations.
  - name: Lipsync Batches
    description: Create and track batches of lipsyncs.
  - name: Asset Batches
    description: Create and track batches of direct-to-S3 asset uploads.
  - name: User
    description: Account information and billing
  - name: Avatars
    description: List and manage avatars and looks
  - name: Avatar Realtime
    description: >-
      Low-latency streaming avatar sessions — create a stream, poll for its HLS
      URL, push text, consume per-word timestamps
  - name: Assets
    description: Upload files for use in video creation
  - name: Webhooks
    description: Manage webhook endpoints and events
  - name: Lipsync
    description: Dub or replace audio on existing videos
  - name: Brand
    description: >-
      Brand-related resources — brand kits (colors, fonts, logos) and brand
      glossaries (custom term translations)
  - name: HyperFrames
    description: Render HyperFrames composition zips into video — separate from /v3/videos
  - name: Filler Word Removal
    description: ''
paths:
  /v3/filler-word-removals:
    post:
      tags:
        - Filler Word Removal
      summary: Create Filler Word Removal
      description: >-
        Submit a video and return a job id immediately. The job runs
        asynchronously: it transcribes the audio, detects filler words ('um',
        'uh', ...), removes them along with overlong silences, and renders one
        cleaned video — no review step. If the run changes nothing at all, the
        job completes with the original video as output and the charge is
        automatically refunded. Pricing: $0.60 per source minute, 1-minute
        minimum. Poll GET /v3/filler-word-removals/{id} or subscribe to
        filler_word_removal.success / filler_word_removal.fail webhooks.
      operationId: createFillerWordRemovalV3
      parameters:
        - $ref: '#/components/parameters/IdempotencyKey'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateFillerWordRemovalRequest'
      responses:
        '202':
          description: Accepted — submission acknowledged; poll for completion.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/CreateFillerWordRemovalResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              examples:
                invalid_parameter:
                  summary: Unusable source (zero duration / probe timeout)
                  value:
                    error:
                      code: invalid_parameter
                      message: >-
                        The input video reports a zero duration — provide a
                        valid video source.
                      param: video
                      doc_url: null
                video_too_long:
                  summary: Source exceeds the 2-hour cap
                  value:
                    error:
                      code: video_too_long
                      message: >-
                        The input video is 7305s long; the maximum supported
                        duration is 7200s (2 hours).
                      param: video
                      doc_url: null
                no_audio_track:
                  summary: Source has no audio stream
                  value:
                    error:
                      code: no_audio_track
                      message: >-
                        The input video has no audio track. Filler removal needs
                        speech audio to transcribe.
                      param: video
                      doc_url: null
                download_failed:
                  summary: Source URL unreachable or unreadable
                  value:
                    error:
                      code: download_failed
                      message: >-
                        Could not read the input video — provide a valid,
                        accessible video URL or asset_id.
                      param: video
                      doc_url: null
        '401':
          description: Authentication failed
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: authentication_failed
                  message: Invalid or expired API key. Verify your x-api-key header.
                  param: null
                  doc_url: null
        '402':
          description: Insufficient credit
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: insufficient_credit
                  message: Not enough premium credits for Speech Cleanup
                  param: null
                  doc_url: null
        '409':
          $ref: '#/components/responses/IdempotencyInProgress'
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    $ref: '#/components/schemas/StandardAPIError'
              example:
                error:
                  code: rate_limit_exceeded
                  message: >-
                    Too many requests. Retry after the duration specified in the
                    Retry-After header.
                  param: null
                  doc_url: null
          headers:
            Retry-After:
              description: Seconds to wait before retrying
              schema:
                type: integer
      security:
        - ApiKeyAuth: []
        - BearerAuth: []
components:
  parameters:
    IdempotencyKey:
      name: Idempotency-Key
      in: header
      required: false
      description: >-
        Optional client-supplied key for safely retrying mutations. Subsequent
        calls within 24 hours that share this key replay the original response —
        even if the request body differs slightly (a warning is logged). A retry
        that arrives while the original is still in flight gets a 409
        `request_in_progress`. Keys must be 1–255 characters from
        `[A-Za-z0-9_:.-]`; a UUID is a safe default. Scope is per-endpoint and
        per-resource: the same key on a different route or path parameter is
        independent.
      schema:
        type: string
        pattern: ^[A-Za-z0-9_\-:.]{1,255}$
        maxLength: 255
        minLength: 1
      example: 550e8400-e29b-41d4-a716-446655440000
  schemas:
    CreateFillerWordRemovalRequest:
      additionalProperties: false
      description: Request body for POST /v3/filler-word-removals.
      properties:
        video:
          description: >-
            Source video to clean. Either a URL or an asset_id from POST
            /v1/asset.
          discriminator:
            mapping:
              asset_id:
                $ref: '#/components/schemas/AssetId'
              url:
                $ref: '#/components/schemas/AssetUrl'
            propertyName: type
          oneOf:
            - $ref: '#/components/schemas/AssetUrl'
            - $ref: '#/components/schemas/AssetId'
          title: Video
        title:
          anyOf:
            - maxLength: 255
              type: string
            - type: 'null'
          default: null
          description: Display title for the job. Defaults to 'Filler Removal' if omitted.
          title: Title
        callback_url:
          anyOf:
            - type: string
            - type: 'null'
          default: null
          description: >-
            HTTPS URL to receive per-job webhook callbacks
            (filler_word_removal.success / filler_word_removal.fail). Delivery
            is best-effort with limited retries — poll GET
            /v3/filler-word-removals/{id} as the source of truth (a terminal GET
            may precede its webhook). Per-job callback_url deliveries are NOT
            HMAC-signed: authenticate them by verifying TLS and matching the
            echoed callback_id, and do not trust an unverified body. To receive
            a signed payload, register a webhook endpoint with a secret via
            /v3/webhooks/endpoints.
          title: Callback Url
        callback_id:
          anyOf:
            - maxLength: 128
              type: string
            - type: 'null'
          default: null
          description: Opaque client identifier echoed verbatim in webhook payloads.
          title: Callback Id
      required:
        - video
      title: CreateFillerWordRemovalRequest
      type: object
    CreateFillerWordRemovalResponse:
      description: >-
        Response for POST /v3/filler-word-removals. Mirrors the v3 single-ID
        create shape.
      properties:
        filler_word_removal_id:
          description: Unique job identifier. Use with GET /v3/filler-word-removals/{id}.
          title: Filler Word Removal Id
          type: string
      required:
        - filler_word_removal_id
      title: CreateFillerWordRemovalResponse
      type: object
    StandardAPIError:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code
          example: invalid_parameter
        message:
          type: string
          description: Human-readable error message
          example: Video not found
        param:
          type:
            - string
            - 'null'
          description: Which request field caused the error
        doc_url:
          type:
            - string
            - 'null'
          description: Link to error documentation
      required:
        - code
        - message
    AssetId:
      additionalProperties: false
      description: Asset input via HeyGen asset ID from the asset upload endpoint.
      properties:
        type:
          const: asset_id
          description: Input type discriminator
          title: Type
          type: string
        asset_id:
          description: HeyGen asset ID from the asset upload endpoint
          title: Asset Id
          type: string
      required:
        - type
        - asset_id
      title: AssetId
      type: object
    AssetUrl:
      additionalProperties: false
      description: Asset input via publicly accessible HTTPS URL.
      properties:
        type:
          const: url
          description: Input type discriminator
          title: Type
          type: string
        url:
          description: Publicly accessible HTTPS URL for the asset
          title: Url
          type: string
      required:
        - type
        - url
      title: AssetUrl
      type: object
  responses:
    IdempotencyInProgress:
      description: >-
        A prior request with this Idempotency-Key is still in progress. Wait for
        the original request to complete, then retry.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                $ref: '#/components/schemas/StandardAPIError'
          example:
            error:
              code: request_in_progress
              message: >-
                A request with this Idempotency-Key is already in progress.
                Retry shortly.
              param: null
              doc_url: null
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: HeyGen API key. Obtain from your HeyGen dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth2 bearer token.

````