@runapi.ai/suno 0.2.7 → 0.2.8

package/README.md

@@ -1,8 +1,8 @@
-# Suno AI API JavaScript SDK for RunAPI
+# Suno API JavaScript SDK for RunAPI
 
-The suno ai api JavaScript SDK is the language-specific package for Suno on RunAPI. Use this suno ai api package for song generation, lyrics, vocal, extension, and audio transformation flows when your application needs JSON request bodies, task status lookup, and consistent RunAPI errors in JavaScript.
+The Suno JavaScript SDK is the language-specific package for Suno on RunAPI. Use this package for song generation, lyrics, vocals, extension, and audio transformation workflows when your application needs request bodies, task status lookup, and consistent RunAPI errors in JavaScript.
 
-This suno ai api README is the JavaScript package guide inside the public `suno-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/suno; for API reference, use https://runapi.ai/docs#suno; for SDK docs, use https://runapi.ai/docs#sdk-suno.
+This README is the JavaScript package guide inside the public `suno-sdk` repository. For the repository overview, start at `../README.md`; for model details, use https://runapi.ai/models/suno; for API reference, use https://runapi.ai/docs#suno; for SDK docs, use https://runapi.ai/docs#sdk-suno.
 
 ## Install
 
@@ -16,10 +16,10 @@ npm install @runapi.ai/suno
 import { SunoClient } from '@runapi.ai/suno';
 
 const client = new SunoClient();
-const task = await client.generations.create({
+const task = await client.textToMusic.create({
   // Pass the Suno JSON request body from https://runapi.ai/docs#suno.
 });
-const status = await client.generations.get(task.id);
+const status = await client.textToMusic.get(task.id);
 ```
 
 Use `create` when you want to submit a task and return quickly, `get` when you need the latest task state, and `run` when a script should create and poll until completion. In web request handlers, prefer `create` plus webhook or later `get` polling so a worker is not held open.
@@ -28,7 +28,7 @@ RunAPI-generated file URLs are temporary. Download and store generated images, v
 
 ## Language notes
 
-Use the TypeScript types in `src/types.ts` and the resource classes under `src/resources` when building music applications. The available resources include generations, extensions, upload and extensions, covers, upload and covers, instrumentals, vocals, vocal removals, midi, wav conversions, music videos, lyrics, timestamped lyrics, section replacements, mashups, sounds, personas, and styles. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
+Use the TypeScript types in `src/types.ts` and the resource classes under `src/resources` when building music applications. The available resources are `textToMusic`, `extendMusic`, `generateArtwork`, `coverAudio`, `addInstrumental`, `addVocals`, `separateAudioStems`, `generateMidi`, `convertAudio`, `visualizeMusic`, `generateLyrics`, `getTimestampedLyrics`, `replaceSection`, `createMashup`, `textToSound`, `generatePersona`, `boostStyle`, `voiceToValidationPhrase`, `regenerateValidationPhrase`, `generateVoice`, and `checkVoice`. Keep `RUNAPI_API_KEY` in the environment or your secret manager; never commit API keys or callback secrets.
 
 ## Links
 

package/dist/index.d.mts

@@ -226,27 +226,40 @@ interface GetTimestampedLyricsParams {
     audio_id: string;
     callback_url?: string;
 }
-/**
- * Params for re-generating a time range within an existing track with new lyrics and style.
- * `infill_start_time` and `infill_end_time` define the section boundaries in seconds.
- */
-interface ReplaceSectionParams {
-    task_id: string;
-    audio_id: string;
+interface ReplaceSectionBaseParams {
     /** Replacement lyrics for the specified section. */
     lyrics: string;
     /** Style/genre tags for the replacement section. */
     tags: string;
     title: string;
-    /** Section start time in seconds. */
+    /** Section start time in seconds. The replacement window must be 6-60 seconds. */
     infill_start_time: number;
-    /** Section end time in seconds. */
+    /** Section end time in seconds; must be greater than infill_start_time. */
     infill_end_time: number;
     callback_url?: string;
     negative_tags?: string;
     /** Complete song lyrics for context; helps maintain coherence across sections. */
-    full_lyrics?: string;
+    full_lyrics: string;
 }
+/** Replace a section using an existing generated audio track. */
+interface ReplaceSectionExistingAudioParams extends ReplaceSectionBaseParams {
+    task_id: string;
+    audio_id: string;
+    upload_url?: never;
+    model?: never;
+}
+/** Replace a section using an uploaded source audio file. */
+interface ReplaceSectionUploadedAudioParams extends ReplaceSectionBaseParams {
+    upload_url: string;
+    model: SunoModel;
+    task_id?: never;
+    audio_id?: never;
+}
+/**
+ * Params for re-generating a time range within a track with new lyrics and style.
+ * Provide either `task_id` + `audio_id` for an existing generated track, or `upload_url` + `model` for uploaded audio.
+ */
+type ReplaceSectionParams = ReplaceSectionExistingAudioParams | ReplaceSectionUploadedAudioParams;
 /**
  * Params for creating a reusable persona from an existing track's vocals.
  * The persona can be referenced by ID in subsequent generation params. Synchronous -- use `run()` directly.
@@ -1210,4 +1223,4 @@ declare class SunoClient extends BaseClient {
     constructor(options?: ClientOptions);
 }
 
-export { type AddInstrumentalParams, type AddInstrumentalResponse, type AddVocalsParams, type AddVocalsResponse, type AlignedWord, type AsyncTaskResponse, type Audio, type BoostStyleParams, type BoostStyleResponse, type CheckVoiceParams, type CheckVoiceResponse, type CompletedAddInstrumentalResponse, type CompletedAddVocalsResponse, type CompletedConvertAudioResponse, type CompletedCoverAudioResponse, type CompletedCreateMashupResponse, type CompletedExtendMusicResponse, type CompletedGenerateArtworkResponse, type CompletedGenerateLyricsResponse, type CompletedGenerateMidiResponse, type CompletedReplaceSectionResponse, type CompletedSeparateAudioStemsResponse, type CompletedTextToMusicResponse, type CompletedTextToSoundResponse, type CompletedValidationPhraseResponse, type CompletedVisualizeMusicResponse, type CompletedVoiceGenerationResponse, type ConvertAudioParams, type ConvertAudioResponse, type CoverAudioInstrumentalParams, type CoverAudioLyricsParams, type CoverAudioParams, type CoverAudioPromptParams, type CoverAudioResponse, type CreateMashupInstrumentalParams, type CreateMashupLyricsParams, type CreateMashupParams, type CreateMashupPromptParams, type CreateMashupResponse, type ExtendMusicParams, type ExtendMusicResponse, type GenerateArtworkParams, type GenerateArtworkResponse, type GenerateLyricsParams, type GenerateLyricsResponse, type GenerateMidiParams, type GenerateMidiResponse, type GeneratePersonaParams, type GeneratePersonaResponse, type GenerateVoiceParams, type GenerationStage, type GetTimestampedLyricsParams, type GetTimestampedLyricsResponse, type MidiInstrument, type MidiNote, type ParameterMode, type Persona, type PersonaType, type RegenerateValidationPhraseParams, type ReplaceSectionParams, type ReplaceSectionResponse, type SeparateAudioStemsParams, type SeparateAudioStemsResponse, type SeparatedAudio, type SingerSkillLevel, type SoundAudio, type SoundKey, type SoundModel, type SunoBaseParams, SunoClient, type SunoModel, type TaskCreateResponse, type TaskStatus, type TextToMusicInstrumentalParams, type TextToMusicLyricsParams, type TextToMusicParams, type TextToMusicPromptParams, type TextToMusicResponse, type TextToSoundParams, type TextToSoundResponse, type ValidationPhraseLanguage, type ValidationPhraseResponse, type VisualizeMusicParams, type VisualizeMusicResponse, type VocalGender, type VocalMode, type VoiceGenerationResponse, type VoiceToValidationPhraseParams };
+export { type AddInstrumentalParams, type AddInstrumentalResponse, type AddVocalsParams, type AddVocalsResponse, type AlignedWord, type AsyncTaskResponse, type Audio, type BoostStyleParams, type BoostStyleResponse, type CheckVoiceParams, type CheckVoiceResponse, type CompletedAddInstrumentalResponse, type CompletedAddVocalsResponse, type CompletedConvertAudioResponse, type CompletedCoverAudioResponse, type CompletedCreateMashupResponse, type CompletedExtendMusicResponse, type CompletedGenerateArtworkResponse, type CompletedGenerateLyricsResponse, type CompletedGenerateMidiResponse, type CompletedReplaceSectionResponse, type CompletedSeparateAudioStemsResponse, type CompletedTextToMusicResponse, type CompletedTextToSoundResponse, type CompletedValidationPhraseResponse, type CompletedVisualizeMusicResponse, type CompletedVoiceGenerationResponse, type ConvertAudioParams, type ConvertAudioResponse, type CoverAudioInstrumentalParams, type CoverAudioLyricsParams, type CoverAudioParams, type CoverAudioPromptParams, type CoverAudioResponse, type CreateMashupInstrumentalParams, type CreateMashupLyricsParams, type CreateMashupParams, type CreateMashupPromptParams, type CreateMashupResponse, type ExtendMusicParams, type ExtendMusicResponse, type GenerateArtworkParams, type GenerateArtworkResponse, type GenerateLyricsParams, type GenerateLyricsResponse, type GenerateMidiParams, type GenerateMidiResponse, type GeneratePersonaParams, type GeneratePersonaResponse, type GenerateVoiceParams, type GenerationStage, type GetTimestampedLyricsParams, type GetTimestampedLyricsResponse, type MidiInstrument, type MidiNote, type ParameterMode, type Persona, type PersonaType, type RegenerateValidationPhraseParams, type ReplaceSectionExistingAudioParams, type ReplaceSectionParams, type ReplaceSectionResponse, type ReplaceSectionUploadedAudioParams, type SeparateAudioStemsParams, type SeparateAudioStemsResponse, type SeparatedAudio, type SingerSkillLevel, type SoundAudio, type SoundKey, type SoundModel, type SunoBaseParams, SunoClient, type SunoModel, type TaskCreateResponse, type TaskStatus, type TextToMusicInstrumentalParams, type TextToMusicLyricsParams, type TextToMusicParams, type TextToMusicPromptParams, type TextToMusicResponse, type TextToSoundParams, type TextToSoundResponse, type ValidationPhraseLanguage, type ValidationPhraseResponse, type VisualizeMusicParams, type VisualizeMusicResponse, type VocalGender, type VocalMode, type VoiceGenerationResponse, type VoiceToValidationPhraseParams };

package/dist/index.d.ts

@@ -226,27 +226,40 @@ interface GetTimestampedLyricsParams {
     audio_id: string;
     callback_url?: string;
 }
-/**
- * Params for re-generating a time range within an existing track with new lyrics and style.
- * `infill_start_time` and `infill_end_time` define the section boundaries in seconds.
- */
-interface ReplaceSectionParams {
-    task_id: string;
-    audio_id: string;
+interface ReplaceSectionBaseParams {
     /** Replacement lyrics for the specified section. */
     lyrics: string;
     /** Style/genre tags for the replacement section. */
     tags: string;
     title: string;
-    /** Section start time in seconds. */
+    /** Section start time in seconds. The replacement window must be 6-60 seconds. */
     infill_start_time: number;
-    /** Section end time in seconds. */
+    /** Section end time in seconds; must be greater than infill_start_time. */
     infill_end_time: number;
     callback_url?: string;
     negative_tags?: string;
     /** Complete song lyrics for context; helps maintain coherence across sections. */
-    full_lyrics?: string;
+    full_lyrics: string;
 }
+/** Replace a section using an existing generated audio track. */
+interface ReplaceSectionExistingAudioParams extends ReplaceSectionBaseParams {
+    task_id: string;
+    audio_id: string;
+    upload_url?: never;
+    model?: never;
+}
+/** Replace a section using an uploaded source audio file. */
+interface ReplaceSectionUploadedAudioParams extends ReplaceSectionBaseParams {
+    upload_url: string;
+    model: SunoModel;
+    task_id?: never;
+    audio_id?: never;
+}
+/**
+ * Params for re-generating a time range within a track with new lyrics and style.
+ * Provide either `task_id` + `audio_id` for an existing generated track, or `upload_url` + `model` for uploaded audio.
+ */
+type ReplaceSectionParams = ReplaceSectionExistingAudioParams | ReplaceSectionUploadedAudioParams;
 /**
  * Params for creating a reusable persona from an existing track's vocals.
  * The persona can be referenced by ID in subsequent generation params. Synchronous -- use `run()` directly.
@@ -1210,4 +1223,4 @@ declare class SunoClient extends BaseClient {
     constructor(options?: ClientOptions);
 }
 
-export { type AddInstrumentalParams, type AddInstrumentalResponse, type AddVocalsParams, type AddVocalsResponse, type AlignedWord, type AsyncTaskResponse, type Audio, type BoostStyleParams, type BoostStyleResponse, type CheckVoiceParams, type CheckVoiceResponse, type CompletedAddInstrumentalResponse, type CompletedAddVocalsResponse, type CompletedConvertAudioResponse, type CompletedCoverAudioResponse, type CompletedCreateMashupResponse, type CompletedExtendMusicResponse, type CompletedGenerateArtworkResponse, type CompletedGenerateLyricsResponse, type CompletedGenerateMidiResponse, type CompletedReplaceSectionResponse, type CompletedSeparateAudioStemsResponse, type CompletedTextToMusicResponse, type CompletedTextToSoundResponse, type CompletedValidationPhraseResponse, type CompletedVisualizeMusicResponse, type CompletedVoiceGenerationResponse, type ConvertAudioParams, type ConvertAudioResponse, type CoverAudioInstrumentalParams, type CoverAudioLyricsParams, type CoverAudioParams, type CoverAudioPromptParams, type CoverAudioResponse, type CreateMashupInstrumentalParams, type CreateMashupLyricsParams, type CreateMashupParams, type CreateMashupPromptParams, type CreateMashupResponse, type ExtendMusicParams, type ExtendMusicResponse, type GenerateArtworkParams, type GenerateArtworkResponse, type GenerateLyricsParams, type GenerateLyricsResponse, type GenerateMidiParams, type GenerateMidiResponse, type GeneratePersonaParams, type GeneratePersonaResponse, type GenerateVoiceParams, type GenerationStage, type GetTimestampedLyricsParams, type GetTimestampedLyricsResponse, type MidiInstrument, type MidiNote, type ParameterMode, type Persona, type PersonaType, type RegenerateValidationPhraseParams, type ReplaceSectionParams, type ReplaceSectionResponse, type SeparateAudioStemsParams, type SeparateAudioStemsResponse, type SeparatedAudio, type SingerSkillLevel, type SoundAudio, type SoundKey, type SoundModel, type SunoBaseParams, SunoClient, type SunoModel, type TaskCreateResponse, type TaskStatus, type TextToMusicInstrumentalParams, type TextToMusicLyricsParams, type TextToMusicParams, type TextToMusicPromptParams, type TextToMusicResponse, type TextToSoundParams, type TextToSoundResponse, type ValidationPhraseLanguage, type ValidationPhraseResponse, type VisualizeMusicParams, type VisualizeMusicResponse, type VocalGender, type VocalMode, type VoiceGenerationResponse, type VoiceToValidationPhraseParams };
+export { type AddInstrumentalParams, type AddInstrumentalResponse, type AddVocalsParams, type AddVocalsResponse, type AlignedWord, type AsyncTaskResponse, type Audio, type BoostStyleParams, type BoostStyleResponse, type CheckVoiceParams, type CheckVoiceResponse, type CompletedAddInstrumentalResponse, type CompletedAddVocalsResponse, type CompletedConvertAudioResponse, type CompletedCoverAudioResponse, type CompletedCreateMashupResponse, type CompletedExtendMusicResponse, type CompletedGenerateArtworkResponse, type CompletedGenerateLyricsResponse, type CompletedGenerateMidiResponse, type CompletedReplaceSectionResponse, type CompletedSeparateAudioStemsResponse, type CompletedTextToMusicResponse, type CompletedTextToSoundResponse, type CompletedValidationPhraseResponse, type CompletedVisualizeMusicResponse, type CompletedVoiceGenerationResponse, type ConvertAudioParams, type ConvertAudioResponse, type CoverAudioInstrumentalParams, type CoverAudioLyricsParams, type CoverAudioParams, type CoverAudioPromptParams, type CoverAudioResponse, type CreateMashupInstrumentalParams, type CreateMashupLyricsParams, type CreateMashupParams, type CreateMashupPromptParams, type CreateMashupResponse, type ExtendMusicParams, type ExtendMusicResponse, type GenerateArtworkParams, type GenerateArtworkResponse, type GenerateLyricsParams, type GenerateLyricsResponse, type GenerateMidiParams, type GenerateMidiResponse, type GeneratePersonaParams, type GeneratePersonaResponse, type GenerateVoiceParams, type GenerationStage, type GetTimestampedLyricsParams, type GetTimestampedLyricsResponse, type MidiInstrument, type MidiNote, type ParameterMode, type Persona, type PersonaType, type RegenerateValidationPhraseParams, type ReplaceSectionExistingAudioParams, type ReplaceSectionParams, type ReplaceSectionResponse, type ReplaceSectionUploadedAudioParams, type SeparateAudioStemsParams, type SeparateAudioStemsResponse, type SeparatedAudio, type SingerSkillLevel, type SoundAudio, type SoundKey, type SoundModel, type SunoBaseParams, SunoClient, type SunoModel, type TaskCreateResponse, type TaskStatus, type TextToMusicInstrumentalParams, type TextToMusicLyricsParams, type TextToMusicParams, type TextToMusicPromptParams, type TextToMusicResponse, type TextToSoundParams, type TextToSoundResponse, type ValidationPhraseLanguage, type ValidationPhraseResponse, type VisualizeMusicParams, type VisualizeMusicResponse, type VocalGender, type VocalMode, type VoiceGenerationResponse, type VoiceToValidationPhraseParams };