> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tryhamsa.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Voice Overs

> Your voice overs in this project, newest first, with their takes and videos. Voice overs belong to the person who made them: an API key sees and changes the voice overs of its creator in its project.

Needs **Read** on **Voice overs** (`voice_overs:read`).



## OpenAPI

````yaml /api-reference/openapi.json get /v2/voice-overs
openapi: 3.0.1
info:
  title: Hamsa API
  description: >-
    The Hamsa API: voice agents and their calls, phone numbers, batch calls and
    knowledge bases; speech to text, text to speech, voices and AI content.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.tryhamsa.com
security: []
paths:
  /v2/voice-overs:
    get:
      tags: []
      summary: List voice overs
      description: >-
        Your voice overs in this project, newest first, with their takes and
        videos. Voice overs belong to the person who made them: an API key sees
        and changes the voice overs of its creator in its project.


        Needs **Read** on **Voice overs** (`voice_overs:read`).
      parameters:
        - in: query
          name: page
          required: false
          description: Page number, from 1.
          schema:
            type: integer
            minimum: 1
            default: 1
        - in: query
          name: perPage
          required: false
          description: Voice overs per page.
          schema:
            type: integer
            minimum: 1
            default: 10
      responses:
        '200':
          description: A page of voice overs.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      voiceOvers:
                        type: array
                        items:
                          $ref: '#/components/schemas/VoiceOver'
                      totalCount:
                        type: integer
                        example: 14
                      totalPages:
                        type: integer
                        example: 2
                      page:
                        type: integer
                        example: 1
        '400':
          description: '`page` or `perPage` isn''t a positive whole number.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '403':
          description: The key's scopes don't allow this (it needs `voice_overs:read`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '500':
          description: Server Side Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    VoiceOver:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: bd0ebca4-a16e-488b-b195-4690792259c7
        title:
          type: string
          description: The first 50 characters of the description or script.
          example: A 30-second ad for a new coffee shop in Cairo
        prompt:
          type: string
          nullable: true
          description: The description you gave for suggested scripts.
          example: A 30-second ad for a new coffee shop in Cairo
        media:
          type: string
          nullable: true
          description: A file brief added in Hamsa Media, if any.
          example: null
        type:
          type: string
          enum:
            - POETRY
            - COMMERCIAL
            - RELIGIOUS
            - STORIES
          example: COMMERCIAL
        status:
          type: string
          enum:
            - IN_PROGRESS
            - READY
            - APPROVED
            - FAILED
          description: >-
            `IN_PROGRESS` while the takes are made. `READY`: two or three takes
            are done; choose one with Approve Voice Over. `APPROVED`: a take is
            chosen (automatic when only one take succeeds, and for voice overs
            from your own script). `FAILED`: no take could be made.
          example: APPROVED
        totalCost:
          type: number
          description: 'Credits charged: the voice over, plus each completed video.'
          example: 2
        voiceOverSuggestions:
          type: array
          items:
            $ref: '#/components/schemas/VoiceOverSuggestion'
        voiceOverVideos:
          type: array
          description: Videos made from it, newest first.
          items:
            $ref: '#/components/schemas/VoiceOverVideo'
        latestVideo:
          type: object
          nullable: true
          description: The newest video, if any.
          properties:
            id:
              type: string
              format: uuid
              example: 3e9a7c21-5b4d-4f8e-a1c2-7d6e5f4a3b29
            status:
              type: string
              example: COMPLETED
            generationStep:
              type: string
              nullable: true
              example: FULLY_GENERATED
            videoUrl:
              type: string
              nullable: true
            updatedAt:
              type: string
              format: date-time
        createdAt:
          type: string
          format: date-time
          example: '2026-11-04T09:10:12.000Z'
    ErrorSchema:
      type: object
      properties:
        code:
          type: integer
          description: >-
            Service error code: the HTTP status with a service prefix (for
            example `8404`). Missing when the service has no code for that
            status.
          example: 8404
        message:
          type: string
          description: >-
            What went wrong. Some services (calls and recordings) put the error
            key here, for example `CallNotFoundOrUnavailable`, and send no
            `messageKey`.
          example: Policy not found!
        messageKey:
          type: string
          description: >-
            Stable key for the error, safe to match on in code. Not returned by
            every service.
          example: PolicyNotFound
        params:
          type: object
          additionalProperties: true
          description: >-
            Details for some errors (for example `reason`). Not returned by
            every service.
          example:
            reason: NO_DRAFT
    VoiceOverSuggestion:
      type: object
      description: >-
        One take of the voice over: a script read by a voice, with or without
        music.
      properties:
        id:
          type: string
          format: uuid
          example: c816c6f6-9d49-4b5d-8c87-4a7a24fc8af1
        status:
          type: string
          example: COMPLETED
          enum:
            - PENDING
            - COMPLETED
            - FAILED
        approved:
          type: boolean
          description: Whether this is the chosen take.
          example: true
        audio:
          type: string
          nullable: true
          description: >-
            Link to the WAV file, once completed. It expires after a while: read
            the voice over again for a fresh one.
          example: https://cdn.example.com/voice-overs/take.wav?Signature=...
        voiceOverText:
          type: string
          nullable: true
          example: ابدأ يومك بقهوة تستحقها...
        ttsVoiceId:
          type: string
          format: uuid
          nullable: true
          example: 6a1f0c2e-8b7d-4e3a-9c5b-2d4f6e8a0b13
        ttsVoice:
          type: object
          nullable: true
          properties:
            id:
              type: string
              format: uuid
              example: 6a1f0c2e-8b7d-4e3a-9c5b-2d4f6e8a0b13
            name:
              type: string
              example: Amjad
            image:
              type: string
              nullable: true
              example: null
            dialect:
              type: object
              properties:
                name:
                  type: string
                  example: Palestine
        includeBackgroundMusic:
          type: boolean
          example: true
        voiceOverBackgroundMusicId:
          type: string
          format: uuid
          nullable: true
          example: 9a1f3b5c-7d2e-4f6a-8b0c-1d3e5f7a9b24
        backgroundMusicStartOffset:
          type: number
          nullable: true
          description: Seconds.
          example: 0
        backgroundMusicEndOffset:
          type: number
          nullable: true
          description: Seconds.
          example: 0
        fadeIn:
          type: boolean
          example: true
        fadeOut:
          type: boolean
          example: true
    VoiceOverVideo:
      type: object
      properties:
        id:
          type: string
          format: uuid
          example: 3e9a7c21-5b4d-4f8e-a1c2-7d6e5f4a3b29
        status:
          type: string
          enum:
            - IN_PROGRESS
            - COMPLETED
            - FAILED
          example: COMPLETED
        generationStep:
          type: string
          nullable: true
          description: >-
            Progress while it is made: `GENERATING_SCENES`,
            `GENERATING_SCENE_2_OF_6`, `CONCATING_SCENES`, `GENERATING_VIDEO`,
            then `FULLY_GENERATED`.
          example: FULLY_GENERATED
        videoUrl:
          type: string
          nullable: true
          description: Link to the MP4, once completed. It expires after a while.
          example: https://cdn.example.com/voice-overs/video.mp4?Signature=...
        style:
          type: string
          enum:
            - REALISTIC
            - CARTOON
            - INFO_GRAPHIC
          example: REALISTIC
        aspectRatio:
          type: string
          enum:
            - '9:16'
            - '16:9'
          example: '9:16'
        includeSubtitles:
          type: boolean
          example: true
        captionStyle:
          type: string
          nullable: true
          enum:
            - WORD_BY_WORD
            - BUILD_UP
            - FULL_SENTENCE
          example: WORD_BY_WORD
        transition:
          type: string
          nullable: true
          enum:
            - FADE
            - DISSOLVE
            - SLIDE_LEFT
            - SLIDE_RIGHT
            - CIRCLE_OPEN
            - WIPE_LEFT
            - ZOOM_IN
          example: FADE
        kenBurnsEnabled:
          type: boolean
          example: false
        voiceOverSuggestionId:
          type: string
          format: uuid
          example: c816c6f6-9d49-4b5d-8c87-4a7a24fc8af1
        voiceOverVideoAttachments:
          type: array
          description: Reference images added in Hamsa Media.
          items:
            type: object
            properties:
              id:
                type: string
                format: uuid
              attachment:
                type: string
          example:
            - id: 7b2c9e41-3a5d-4f6b-8c1e-2d4f6a8b0c35
              attachment: https://cdn.example.com/voice-overs/reference.jpg?Signature=...
        createdAt:
          type: string
          format: date-time
          example: '2026-11-04T09:12:44.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2026-11-04T09:16:02.000Z'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: >-
        Pass the API key in the Authorization header, You need to put Token
        keyword before the API key. e.g. 'Authorization: Token <api-key>'

````

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