For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
PlaygroundChangelogSign In
OverviewAPI ReferencePre-recorded STTStreaming STTVoice AgentsSpeech UnderstandingGuardrailsLLM GatewayFAQ
OverviewAPI ReferencePre-recorded STTStreaming STTVoice AgentsSpeech UnderstandingGuardrailsLLM GatewayFAQ
  • Getting started
    • Transcribe a pre-recorded audio file
    • Model selection
    • View model benchmarks
    • Evaluate model accuracy
    • Cloud endpoints & data residency
    • Manage concurrent requests
    • Webhooks
  • Models
    • Medical Mode
  • Features
    • Boost specific terms
    • Label speakers
    • Transcribe multiple audio channels
    • Transcribe audio with mixed languages
    • Correct spelling of terms
    • Include filler words
    • Search for words in transcript
    • Set the start and end of the transcript
  • Guides
      • Build a meeting notetaker
      • Build a medical scribe
      • Build a contact center application
        • Transcribe from an S3 Bucket
        • Transcribe a Google Drive File
        • Transcribe GitHub Files
LogoLogo
PlaygroundChangelogSign In
On this page
  • Step 1: Upload Your Audio Files to a Public GitHub Repository
  • Step 2: Obtain the Raw Audio URL from GitHub
  • Step 3: Add the Audio URL to your Request
  • Resources
GuidesTutorialsHosting audio files

Transcribe GitHub Files

Was this page helpful?
Previous

Iterate over Speaker Labels with Make.com

Next
Built with

Step 1: Upload Your Audio Files to a Public GitHub Repository

  • File Requirements: GitHub has a file size limit of 100MB so ensure your audio files are 100MB in size or less. The files must be in a public repository otherwise you will receive an error saying the file is not publicly accessible. For a more secure way to host files check out our Transcribing from an S3 Bucket Cookbook.

Step 2: Obtain the Raw Audio URL from GitHub

  1. Navigate to the repository that houses the audio file.
  2. Click on the audio file. On the next page, right-click the “View raw” link and select “copy the link address” from the context menu.

Downloadable file URLs are formatted as "https://github.com/<github-username>/<repo-name>/raw/<branch-name>/<file-name-and extension>"

Step 3: Add the Audio URL to your Request

POST v2/transcript endpoint

1{
2    "audio_url":"https://github.com/user/audio-files/raw/main/audio.mp3",
3    "speech_models": ["universal-3-pro", "universal-2"]
4}

Python SDK

1config = aai.TranscriptionConfig(speech_models=["universal-3-pro", "universal-2"])
2transcript = transcriber.transcribe("https://github.com/user/audio-files/raw/main/audio.mp3", config)

JavaScript SDK

1const transcript = await client.transcripts.transcribe({
2  audio_url: "https://github.com/user/audio-files/raw/main/audio.mp3",
3  speech_models: ["universal-3-pro", "universal-2"],
4});

Resources

AssemblyAI’s Supported File Types
Transcribe an Audio File