deepgram-upgrade-migration

name	deepgram-upgrade-migration
description	Plan and execute Deepgram SDK upgrades and model migrations. Use when upgrading SDK versions (v3 to v4 to v5), migrating models (Nova-2 to Nova-3), or planning API version transitions. Trigger: "upgrade deepgram", "deepgram migration", "update deepgram SDK", "deepgram version upgrade", "nova-3 migration".
allowed-tools	Read, Write, Edit, Grep, Bash(npm:*), Bash(pip:*)
version	1.13.0
license	MIT
author	Jeremy Longshore <[e-mail]>
tags	["saas","deepgram","api","migration","upgrade"]
compatibility	Designed for Claude Code, also compatible with Codex and OpenClaw

Deepgram Upgrade Migration

Current State

!npm list @deepgram/sdk 2>/dev/null | grep deepgram || echo 'SDK not installed'

Overview

Guide for Deepgram SDK version upgrades (v3 -> v4 -> v5) and model migrations (Nova-2 -> Nova-3). Includes breaking change maps, side-by-side API comparison, A/B testing scripts, automated validation, and rollback procedures.

SDK Version History

Version	Client Init	STT API	Live API	TTS API	Status
v3.x	createClient(key)	listen.prerecorded.transcribeUrl()	listen.live()	speak.request()	Stable
v4.x	createClient(key)	listen.prerecorded.transcribeUrl()	listen.live()	speak.request()	Stable
v5.x	new DeepgramClient({apiKey})	listen.v1.media.transcribeUrl()	listen.v1.connect()	speak.v1.audio.generate()	Beta

Instructions

Step 1: Identify Current Version and Breaking Changes

# Check installed version
npm list @deepgram/sdk

# Check latest available
npm view @deepgram/sdk versions --json | tail -5

Step 2: v3/v4 to v5 Migration Map

// ============= CLIENT CREATION =============
// v3/v4:
import { createClient } from '@deepgram/sdk';
const dg = createClient(process.env.DEEPGRAM_API_KEY!);

// v5:
import { DeepgramClient }  ;
 dg =  ({ : process.. });



 { result, error } =  dg...(
  { : audioUrl },
  { : , :  }
);


 response =  dg....(
  { : audioUrl },
  { : , :  }
);




 { result, error } =  dg...(
  buffer,
  { : , :  }
);


 response =  dg....(
  (),
  { :  }
);



 connection = dg..({ : , :  });
connection.(.,  { ... });


 connection =  dg...({ : , :  });




 response =  dg..(
  { :  },
  { :  }
);
 stream =  response.();


 response =  dg....(
  { :  },
  { :  }
);



 { result, error } =  dg...(src, opts);
 (error) (error);


 {
   result =  dg....(src, opts);
}  (err) {
  (err);
}