# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Elevenlabs Speech to Text API
  version: 1.0.0
extends: openapi/elevenlabs-speech-to-text-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/v1/speech-to-text'].post
  update:
    x-apievangelist-phrasing:
      intent: Transcribe an audio file to text
      effect: write
      questions:
      - Can ElevenLabs transcribe an MP3 and give me word-level timestamps?
      - Is it possible to tag laughter or applause in a transcript?
      - Should I pass a language hint when transcribing a recording?
      instructions:
      - text: Transcribe {file}.
        slots:
          file: requestBody.file
      - text: Transcribe {file} in language {language_code} with {timestamps_granularity} timestamps.
        slots:
          file: requestBody.file
          language_code: requestBody.language_code
          timestamps_granularity: requestBody.timestamps_granularity
      - text: Transcribe {file} with model {model_id} and tag audio events {tag_audio_events}.
        slots:
          file: requestBody.file
          model_id: requestBody.model_id
          tag_audio_events: requestBody.tag_audio_events
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/speech-to-text/async'].post
  update:
    x-apievangelist-phrasing:
      intent: Transcribe audio in the background
      effect: write
      questions:
      - How do I transcribe a long recording without waiting on the request?
      - Can I get a webhook when an asynchronous transcription finishes?
      instructions:
      - text: Submit {file} for asynchronous transcription.
        slots:
          file: requestBody.file
      - text: Queue a background transcription of {file} and notify {webhook_url} when done.
        slots:
          file: requestBody.file
          webhook_url: requestBody.webhook_url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/speech-to-text/transcripts/{transcription_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a transcript by ID
      effect: read
      questions:
      - Where do I fetch the result of a transcription I submitted earlier?
      - Can I retrieve an old transcript again later?
      instructions:
      - text: Get transcript {transcription_id}.
        slots:
          transcription_id: path.transcription_id
      - text: Fetch the finished text of transcription {transcription_id}.
        slots:
          transcription_id: path.transcription_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/speech-to-text/transcripts/{transcription_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a transcript
      effect: destructive
      questions:
      - How do I delete a stored transcript?
      - Can I remove a transcription after I've downloaded it?
      instructions:
      - text: Delete transcript {transcription_id}.
        slots:
          transcription_id: path.transcription_id
      - text: Remove the stored transcription {transcription_id}.
        slots:
          transcription_id: path.transcription_id
      method: generated
      generated: '2026-09-26'