providerplaneai
    Preparing search index...

    Interface ClientTextToSpeechRequest

    Interface contract for ClientTextToSpeechRequest.

    interface ClientTextToSpeechRequest {
        context?: { metadata?: Record<string, unknown>; requestId?: string };
        format?: ClientTextToSpeechFormat;
        instructions?: string;
        model?: string;
        options?: Record<string, unknown>;
        speed?: number;
        streamFormat?: ClientTextToSpeechStreamFormat;
        text: string;
        voice?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    context? format? instructions? model? options? speed? streamFormat? text voice?

    Properties

    context?: { metadata?: Record<string, unknown>; requestId?: string }

    Execution context (tracing, requestId, etc.) Not sent to the provider.

    format?: ClientTextToSpeechFormat

    Optional output audio format.

    instructions?: string

    Optional style/instruction text for compatible models.

    model?: string
    options?: Record<string, unknown>

    Provider-agnostic tuning options (temperature, max tokens, etc.)

    speed?: number

    Optional speaking speed multiplier.

    streamFormat?: ClientTextToSpeechStreamFormat

    Optional stream format for providers that support streamed TTS output.

    text

    text: string

    Text content to synthesize into speech.

    voice?: string

    Optional voice name (provider-specific, e.g. alloy/nova/verse).

    Settings

    Member Visibility

    On This Page

    Properties