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

# Create design previews

> Generate temporary voice previews from a text description.



## OpenAPI

````yaml /openapi.json post /v1/voice-previews/design
openapi: 3.1.0
info:
  title: Breeze Developer API
  description: >-
    Breeze Developer API for models, voices, text-to-speech, history, balance,
    usage, and browser-managed API keys.
  version: 1.0.0
servers:
  - url: https://api.breeze.blue
security: []
tags:
  - name: Models
    description: Supported TTS models.
  - name: Text to Speech
    description: Text-to-speech synthesis and instruction rewriting.
  - name: Voices
    description: Saved voices and voice settings.
  - name: Voice Previews
    description: Create, audition, and save temporary voice previews.
  - name: Account
    description: Balance, usage, and API keys.
  - name: History
    description: Generated audio history.
paths:
  /v1/voice-previews/design:
    post:
      tags:
        - Voice Previews
      summary: Create design previews
      description: Generate temporary voice previews from a text description.
      operationId: voice_previews_design
      parameters:
        - name: output_format
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Output Format
            default: mp3
          description: >-
            Audio format for the embedded preview payloads. Supported values:
            mp3, wav, flac, pcm, aac, opus. Default: mp3.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/VoiceDesignRequest'
      responses:
        '200':
          description: Generated voice previews.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceDesignResponse'
          headers:
            x-breeze-api-key-id:
              description: >-
                Public API key identifier used to authenticate the request, when
                an API key was used.
              schema:
                type: string
        '400':
          description: HTTP 400 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: HTTP 401 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '422':
          description: HTTP 422 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidationErrorResponse'
        '429':
          description: HTTP 429 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '502':
          description: HTTP 502 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: HTTP 503 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl \
              --request POST \
              --url "https://api.breeze.blue/v1/voice-previews/design" \
              --header "xi-api-key: $BREEZE_API_KEY" \
              --header "Content-Type: application/json" \
              --data '{
              "voice_description": "Warm, intimate narrator with crisp diction.",
              "text": "Welcome to Breeze Blue.",
              "language_code": "en",
              "guidance_scale": 4.0,
              "preview_count": 3
            }'
        - lang: Python
          label: Python SDK
          source: |-
            import os

            from breeze_blue import BreezeBlue

            client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"])

            design = client.voices.create_design_preview(
                voice_description="Warm, intimate narrator with crisp diction.",
                text="Welcome to Breeze Blue.",
                language_code="en",
                guidance_scale=4.0,
                preview_count=3,
            )

            for preview in design["previews"]:
                print(preview["generated_voice_id"])
        - lang: TypeScript
          label: TypeScript SDK
          source: |-
            import { BreezeBlueClient } from "@breeze.blue/sdk";

            const client = new BreezeBlueClient({
              apiKey: process.env.BREEZE_API_KEY!,
            });

            const design = await client.voices.createDesignPreview({
              voiceDescription: "Warm, intimate narrator with crisp diction.",
              text: "Welcome to Breeze Blue.",
              languageCode: "en",
              guidanceScale: 4.0,
              previewCount: 3,
            });

            for (const preview of design.previews) {
              console.log(preview.generatedVoiceId);
            }
components:
  schemas:
    VoiceDesignRequest:
      properties:
        voice_description:
          type: string
          maxLength: 500
          minLength: 3
          title: Voice Description
          description: Text description of the desired voice.
        text:
          anyOf:
            - type: string
              maxLength: 500
              minLength: 3
            - type: 'null'
          title: Text
          description: Optional preview script for the generated voice previews.
        model_id:
          anyOf:
            - type: string
              maxLength: 120
              minLength: 1
            - type: 'null'
          title: Model Id
          description: Optional model identifier to use for generation.
        language_code:
          anyOf:
            - type: string
              maxLength: 16
            - type: 'null'
          title: Language Code
          description: Optional language hint for the generated previews.
        guidance_scale:
          anyOf:
            - type: number
              maximum: 10
              minimum: 1
            - type: 'null'
          title: Guidance Scale
          description: >-
            Optional generation guidance strength for preview generation.
            Accepted range: 1.0 to 10.0. When provided, that exact value is
            used; when omitted, Breeze picks a random value between 1.0 and 10.0
            for the request.
        preview_count:
          anyOf:
            - type: integer
              maximum: 3
              minimum: 1
            - type: 'null'
          title: Preview Count
          description: >-
            Number of preview variants to generate. Defaults to 1 and accepts
            values from 1 to 3.
      additionalProperties: false
      type: object
      required:
        - voice_description
      title: VoiceDesignRequest
    VoiceDesignResponse:
      properties:
        previews:
          items:
            $ref: '#/components/schemas/VoiceDesignPreviewResponse'
          title: Previews
          type: array
        text:
          title: Text
          type: string
      required:
        - previews
        - text
      title: VoiceDesignResponse
      type: object
    ErrorResponse:
      properties:
        ok:
          default: false
          title: Ok
          type: boolean
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        error:
          title: Error
          type: string
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          default: null
          title: Meta
      required:
        - code
        - detail
        - error
      title: ErrorResponse
      type: object
    ValidationErrorResponse:
      properties:
        ok:
          default: false
          title: Ok
          type: boolean
        code:
          title: Code
          type: string
        detail:
          title: Detail
          type: string
        error:
          title: Error
          type: string
        meta:
          anyOf:
            - additionalProperties: true
              type: object
            - type: 'null'
          title: Meta
      required:
        - code
        - detail
        - error
      title: ValidationErrorResponse
      type: object
    VoiceDesignPreviewResponse:
      properties:
        generated_voice_id:
          title: Generated Voice Id
          type: string
        audio_base_64:
          title: Audio Base 64
          type: string
        media_type:
          title: Media Type
          type: string
        duration_secs:
          anyOf:
            - type: number
            - type: 'null'
          default: null
          title: Duration Secs
      required:
        - generated_voice_id
        - audio_base_64
        - media_type
      title: VoiceDesignPreviewResponse
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: xi-api-key
      description: Breeze Developer API key.

````