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

# Put Course Voice

> Set or clear (voice=null) a course's chosen narration voice. Only
while the course is `awaiting_brief` (409 course_not_awaiting_brief
otherwise: generation may already be reading user_preferences, D2/plan
2.5 -- a post-launch write would be a lie).



## OpenAPI

````yaml /openapi.yaml put /api/v1/courses/{course_id}/voice
openapi: 3.1.0
info:
  title: Mahara Platform
  description: >
    AI Sales Training Course Generator, a Coursera-style platform.


    ## Authentication


    Every request must carry your API key as a Bearer token:


    `Authorization: Bearer sk_live_your_key_here`


    ## Getting an API key


    API keys are provisioned by our team. They are not self-service, so there is
    no signup page to apply on. To request access, email **sales@myustadia.com**
    and we will issue a key for your account.
  version: 1.0.0
servers: []
security: []
paths:
  /api/v1/courses/{course_id}/voice:
    put:
      tags:
        - B2B Narration Voices
      summary: Put Course Voice
      description: |-
        Set or clear (voice=null) a course's chosen narration voice. Only
        while the course is `awaiting_brief` (409 course_not_awaiting_brief
        otherwise: generation may already be reading user_preferences, D2/plan
        2.5 -- a post-launch write would be a lie).
      operationId: put_course_voice_api_v1_courses__course_id__voice_put
      parameters:
        - name: course_id
          in: path
          required: true
          schema:
            type: string
            title: Course Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutCourseVoiceRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CourseVoiceResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    PutCourseVoiceRequest:
      properties:
        voice:
          anyOf:
            - type: string
            - type: 'null'
          title: Voice
      type: object
      title: PutCourseVoiceRequest
    CourseVoiceResponse:
      properties:
        course_id:
          type: string
          title: Course Id
        voice:
          anyOf:
            - type: string
            - type: 'null'
          title: Voice
        name:
          anyOf:
            - type: string
            - type: 'null'
          title: Name
        source:
          type: string
          title: Source
      type: object
      required:
        - course_id
        - voice
        - name
        - source
      title: CourseVoiceResponse
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````

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