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

# Create Voice Over

> Your own script, read by the voice you choose, with background music if you want it. It makes one take, which is chosen automatically. It is made in the background: read it with Get Voice Over until `status` changes. You are charged once, when it is ready.

Needs **Create** on **Voice overs** (`voice_overs:create`).



## OpenAPI

````yaml /api-reference/openapi.json post /v2/voice-overs/static
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/static:
    post:
      tags: []
      summary: Create a voice over from your script
      description: >-
        Your own script, read by the voice you choose, with background music if
        you want it. It makes one take, which is chosen automatically. It is
        made in the background: read it with Get Voice Over until `status`
        changes. You are charged once, when it is ready.


        Needs **Create** on **Voice overs** (`voice_overs:create`).
      parameters: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - voiceOverText
                - ttsVoiceId
                - type
              properties:
                voiceOverText:
                  type: string
                  minLength: 1
                  maxLength: 1000
                  description: 'The script: 1 to 1000 characters.'
                  example: ابدأ يومك بقهوة تستحقها، في قلب القاهرة.
                ttsVoiceId:
                  type: string
                  format: uuid
                  description: >-
                    The voice: a public Hamsa Media voice, a voice in this
                    project, or one of your own.
                  example: 6a1f0c2e-8b7d-4e3a-9c5b-2d4f6e8a0b13
                type:
                  type: string
                  enum:
                    - POETRY
                    - COMMERCIAL
                    - RELIGIOUS
                    - STORIES
                  description: >-
                    The kind of voice over. It decides which background music
                    fits.
                  example: COMMERCIAL
                voiceOverBackgroundMusicId:
                  type: string
                  description: >-
                    A track from List Background Music (of the same `type`), or
                    `auto` to let Hamsa pick one and time it. Leave it out for
                    no music.
                  example: auto
      responses:
        '200':
          description: Started. The take starts as `PENDING`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: true
                  message:
                    type: string
                    example: success
                  data:
                    type: object
                    properties:
                      voiceOver:
                        type: object
                        properties:
                          id:
                            type: string
                            format: uuid
                            example: bd0ebca4-a16e-488b-b195-4690792259c7
                          status:
                            type: string
                            example: IN_PROGRESS
                          prompt:
                            type: string
                            nullable: true
                          media:
                            type: string
                            nullable: true
                            example: null
                          type:
                            type: string
                            enum:
                              - POETRY
                              - COMMERCIAL
                              - RELIGIOUS
                              - STORIES
                            example: COMMERCIAL
                          voiceOverSuggestions:
                            type: array
                            items:
                              type: object
                              properties:
                                id:
                                  type: string
                                  format: uuid
                                  example: c816c6f6-9d49-4b5d-8c87-4a7a24fc8af1
                                status:
                                  type: string
                                  example: PENDING
        '400':
          description: >-
            Invalid body, for example "voiceOverText must not exceed 1000
            characters!" or "BackgroundMusicId must be a valid uuid or 'auto'!".
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '402':
          description: >-
            Your balance has run out ("Balance is insufficient, please renew or
            upgrade your plan!").
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '403':
          description: >-
            The key's scopes don't allow this (it needs `voice_overs:create`),
            or the project is deactivated (only reading works then).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorSchema'
        '404':
          description: >-
            You can't use this voice ("TTS voice not found"), or no music fits
            the type ("Background music not found").
          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:
    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
  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.