---
title: "PUT /api/stories/{simulationId}/voiceover"
method: PUT
path: "/api/stories/{simulationId}/voiceover"
tags: ["Stories"]
---

# PUT /api/stories/{simulationId}/voiceover

`PUT /api/stories/{simulationId}/voiceover`

## Request

- Base URL: `https://api.wearelearning.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.wearelearning.io/api/stories/{simulationId}/voiceover`
- Auth: OAuth 2
  - Implicit: `https://login.wearelearning.io/authorize?audience=https://api.wearelearning.io`

## Path parameters

- `simulationId` string, uuid, required: A valid GUID

## Request body

- UpdateStoryVoiceoverDto
  - `enabled` boolean, required
  - `selectedVoiceName` string, required

## Response `200`

OK

- VoiceOverDto
  - `enabled` boolean, required
  - `selectedVoiceName` string, required
  - `gender` 'Female' | 'Male', required
  - `voiceInfo` VoiceDto
    - `displayName` string, required
    - `shortName` string, required
    - `locale` string, required
    - `gender` 'Female' | 'Male', required
    - `sampleAudioUrl` string, required
    - `wordsPerMinute` integer, required
    - `speakingStyles` SpeakingStyle[], required
      - `value` string, required
      - `displayName` string, required
      - `iconUrl` string, required
    - `provider` 'AzureCognitiveServices' | 'ElevenLabs', required
    - `supportsAudioTags` boolean, required
    - `fileFormat` 'Wav' | 'Aac' | 'Mp3', required

---

[API](https://skmtc.dev/wearelearning/apis/we-are-learning-api.md) - [All operations](https://skmtc.dev/wearelearning/apis/we-are-learning-api/llms.txt) - [OpenAPI document](https://skmtc.dev/wearelearning/apis/we-are-learning-api/revisions/e2ca5265db77?raw)
