@runapi.ai/suno 0.2.4 → 0.2.6

package/dist/index.d.ts

@@ -1,13 +1,17 @@
 import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, ClientOptions } from '@runapi.ai/core';
 export { AuthenticationError, InsufficientCreditsError, NetworkError, NotFoundError, RateLimitError, RunApiError, ServiceUnavailableError, TaskFailedError, TaskTimeoutError, TimeoutError, ValidationError } from '@runapi.ai/core';
 
-type SunoModel = 'suno-v5.5' | 'suno-v5' | 'suno-v4.5-plus' | 'suno-v4.5-all' | 'suno-v4.5' | 'suno-v4' | 'suno-v3.5';
+type SunoModel = 'suno-v5.5' | 'suno-v5' | 'suno-v4.5-plus' | 'suno-v4.5-all' | 'suno-v4.5' | 'suno-v4';
 type SoundModel = 'suno-v5' | 'suno-v5.5';
+type ValidationPhraseLanguage = 'en' | 'zh' | 'es' | 'fr' | 'pt' | 'de' | 'ja' | 'ko' | 'hi' | 'ru';
 type SoundKey = 'Cm' | 'C#m' | 'Dm' | 'D#m' | 'Em' | 'Fm' | 'F#m' | 'Gm' | 'G#m' | 'Am' | 'A#m' | 'Bm' | 'C' | 'C#' | 'D' | 'D#' | 'E' | 'F' | 'F#' | 'G' | 'G#' | 'A' | 'A#' | 'B';
-type VocalGender = 'm' | 'f';
-type PersonaModel = 'style_persona' | 'voice_persona';
+type VocalGender = 'male' | 'female';
+type PersonaType = 'style' | 'voice';
+type ParameterMode = 'source' | 'custom';
+type VocalMode = 'auto_lyrics' | 'exact_lyrics' | 'instrumental';
 type TaskStatus = AsyncTaskStatus;
 type GenerationStage = 'text_generated' | 'first_audio_ready' | 'all_audios_ready' | 'failed';
+type SingerSkillLevel = 'beginner' | 'intermediate' | 'advanced' | 'professional';
 interface SunoBaseParams {
     callback_url?: string;
     model?: SunoModel;
@@ -16,38 +20,54 @@ interface SunoBaseParams {
     weirdness_constraint?: number;
     audio_weight?: number;
 }
-interface TextToMusicSimpleParams extends SunoBaseParams {
-    custom_mode: false;
-    instrumental: boolean;
+interface TextToMusicPromptParams extends SunoBaseParams {
+    vocal_mode: 'auto_lyrics';
     prompt: string;
+    lyrics?: never;
+    style?: never;
+    title?: never;
+}
+interface TextToMusicLyricsParams extends SunoBaseParams {
+    vocal_mode: 'exact_lyrics';
+    prompt?: never;
+    lyrics: string;
+    style: string;
+    title: string;
+    persona_id?: string;
+    persona_type?: PersonaType;
+    negative_tags?: string;
+    duration_seconds?: number;
+    continue_at?: number;
+    endpoint?: string;
 }
-interface TextToMusicCustomParams extends SunoBaseParams {
-    custom_mode: true;
-    instrumental: boolean;
+interface TextToMusicInstrumentalParams extends SunoBaseParams {
+    vocal_mode: 'instrumental';
+    prompt?: never;
+    lyrics?: never;
     style: string;
     title: string;
-    prompt?: string;
     persona_id?: string;
-    persona_model?: PersonaModel;
+    persona_type?: PersonaType;
     negative_tags?: string;
-    duration?: number;
+    duration_seconds?: number;
     continue_at?: number;
     endpoint?: string;
 }
-type TextToMusicParams = TextToMusicSimpleParams | TextToMusicCustomParams;
+type TextToMusicParams = TextToMusicPromptParams | TextToMusicLyricsParams | TextToMusicInstrumentalParams;
 interface ExtendMusicParams extends SunoBaseParams {
     task_id?: string;
     audio_id?: string;
     audio_url?: string;
     upload_url?: string;
-    default_param_flag?: boolean;
+    parameter_mode: ParameterMode;
     instrumental?: boolean;
     prompt?: string;
+    lyrics?: string;
     style?: string;
     title?: string;
     continue_at?: number;
     persona_id?: string;
-    persona_model?: PersonaModel;
+    persona_type?: PersonaType;
     model?: SunoModel;
     negative_tags?: string;
 }
@@ -56,25 +76,38 @@ interface GenerateArtworkParams {
     callback_url?: string;
     [key: string]: unknown;
 }
-interface CoverAudioSimpleParams extends SunoBaseParams {
+interface CoverAudioPromptParams extends SunoBaseParams {
     upload_url: string;
-    custom_mode: false;
-    instrumental: boolean;
+    vocal_mode: 'auto_lyrics';
     prompt: string;
+    lyrics?: never;
+    style?: never;
+    title?: never;
     negative_tags?: string;
 }
-interface CoverAudioCustomParams extends SunoBaseParams {
+interface CoverAudioLyricsParams extends SunoBaseParams {
     upload_url: string;
-    custom_mode: true;
-    instrumental: boolean;
+    vocal_mode: 'exact_lyrics';
+    prompt?: never;
+    lyrics: string;
     style: string;
     title: string;
-    prompt?: string;
     persona_id?: string;
-    persona_model?: PersonaModel;
+    persona_type?: PersonaType;
     negative_tags?: string;
 }
-type CoverAudioParams = CoverAudioSimpleParams | CoverAudioCustomParams;
+interface CoverAudioInstrumentalParams extends SunoBaseParams {
+    upload_url: string;
+    vocal_mode: 'instrumental';
+    prompt?: never;
+    lyrics?: never;
+    style: string;
+    title: string;
+    persona_id?: string;
+    persona_type?: PersonaType;
+    negative_tags?: string;
+}
+type CoverAudioParams = CoverAudioPromptParams | CoverAudioLyricsParams | CoverAudioInstrumentalParams;
 interface AddInstrumentalParams extends SunoBaseParams {
     model?: SunoModel;
     upload_url: string;
@@ -85,7 +118,7 @@ interface AddInstrumentalParams extends SunoBaseParams {
 interface AddVocalsParams extends SunoBaseParams {
     model?: SunoModel;
     upload_url: string;
-    prompt: string;
+    lyrics: string;
     title: string;
     negative_tags: string;
     style: string;
@@ -125,7 +158,7 @@ interface GetTimestampedLyricsParams {
 interface ReplaceSectionParams {
     task_id: string;
     audio_id: string;
-    prompt: string;
+    lyrics: string;
     tags: string;
     title: string;
     infill_start_time: number;
@@ -153,29 +186,79 @@ interface TextToSoundParams {
     sound_key?: SoundKey;
     grab_lyrics?: boolean;
 }
-interface CreateMashupSimpleParams extends SunoBaseParams {
+interface VoiceToValidationPhraseParams {
+    voice_url: string;
+    vocal_start_seconds: number;
+    vocal_end_seconds: number;
+    language?: ValidationPhraseLanguage;
+    callback_url?: string;
+}
+interface RegenerateValidationPhraseParams {
+    task_id: string;
+    callback_url?: string;
+}
+interface GenerateVoiceParams {
+    task_id: string;
+    verify_url: string;
+    voice_name?: string;
+    description?: string;
+    style?: string;
+    singer_skill_level?: SingerSkillLevel;
+    callback_url?: string;
+}
+interface CheckVoiceParams {
+    task_id: string;
+}
+interface CreateMashupPromptParams extends SunoBaseParams {
     upload_url_list: [string, string];
-    custom_mode: false;
     model?: SunoModel;
+    vocal_mode: 'auto_lyrics';
     prompt: string;
-    instrumental?: boolean;
+    lyrics?: never;
+    style?: never;
+    title?: never;
 }
-interface CreateMashupCustomParams extends SunoBaseParams {
+interface CreateMashupLyricsParams extends SunoBaseParams {
     upload_url_list: [string, string];
-    custom_mode: true;
     model?: SunoModel;
+    vocal_mode: 'exact_lyrics';
+    prompt?: never;
+    lyrics: string;
     style: string;
     title: string;
-    prompt?: string;
-    instrumental?: boolean;
+    persona_id?: string;
+    persona_type?: PersonaType;
+}
+interface CreateMashupInstrumentalParams extends SunoBaseParams {
+    upload_url_list: [string, string];
+    model?: SunoModel;
+    vocal_mode: 'instrumental';
+    prompt?: never;
+    lyrics?: never;
+    style: string;
+    title: string;
+    persona_id?: string;
+    persona_type?: PersonaType;
 }
-type CreateMashupParams = CreateMashupSimpleParams | CreateMashupCustomParams;
+type CreateMashupParams = CreateMashupPromptParams | CreateMashupLyricsParams | CreateMashupInstrumentalParams;
 interface TaskCreateResponse {
     id: string;
     status?: string;
     [key: string]: unknown;
 }
 interface Audio {
+    id: string;
+    audio_url?: string;
+    stream_audio_url?: string;
+    image_url?: string;
+    lyrics?: string;
+    model_name?: string;
+    title?: string;
+    tags?: string[];
+    duration?: number;
+    [key: string]: unknown;
+}
+interface SoundAudio {
     id: string;
     audio_url?: string;
     stream_audio_url?: string;
@@ -213,7 +296,8 @@ interface AddInstrumentalResponse extends TextToMusicResponse {
 }
 interface AddVocalsResponse extends TextToMusicResponse {
 }
-interface TextToSoundResponse extends TextToMusicResponse {
+interface TextToSoundResponse extends AsyncTaskResponse {
+    audios?: SoundAudio[];
 }
 interface SeparatedAudio {
     vocal_url?: string;
@@ -297,6 +381,19 @@ interface BoostStyleResponse {
 interface CreateMashupResponse extends AsyncTaskResponse {
     audios?: Audio[];
 }
+interface ValidationPhraseResponse extends AsyncTaskResponse {
+    provider_status?: string;
+    validation_phrase?: string;
+}
+interface VoiceGenerationResponse extends AsyncTaskResponse {
+    provider_status?: string;
+    voice_id?: string;
+}
+interface CheckVoiceResponse {
+    is_available?: boolean;
+    error?: string;
+    [key: string]: unknown;
+}
 type CompletedTextToMusicResponse = TextToMusicResponse & {
     status: 'completed';
     audios: Audio[];
@@ -356,7 +453,15 @@ type CompletedCreateMashupResponse = CreateMashupResponse & {
 };
 type CompletedTextToSoundResponse = TextToSoundResponse & {
     status: 'completed';
-    audios: Audio[];
+    audios: SoundAudio[];
+};
+type CompletedValidationPhraseResponse = ValidationPhraseResponse & {
+    status: 'completed';
+    validation_phrase: string;
+};
+type CompletedVoiceGenerationResponse = VoiceGenerationResponse & {
+    status: 'completed';
+    voice_id: string;
 };
 
 declare class TextToMusic {
@@ -489,6 +594,36 @@ declare class BoostStyle {
     run(params: BoostStyleParams, options?: RequestOptions): Promise<BoostStyleResponse>;
 }
 
+declare class VoiceToValidationPhrase {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: VoiceToValidationPhraseParams, options?: RequestOptions & PollingOptions): Promise<CompletedValidationPhraseResponse>;
+    create(params: VoiceToValidationPhraseParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<ValidationPhraseResponse>;
+}
+
+declare class RegenerateValidationPhrase {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: RegenerateValidationPhraseParams, options?: RequestOptions & PollingOptions): Promise<CompletedValidationPhraseResponse>;
+    create(params: RegenerateValidationPhraseParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<ValidationPhraseResponse>;
+}
+
+declare class GenerateVoice {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: GenerateVoiceParams, options?: RequestOptions & PollingOptions): Promise<CompletedVoiceGenerationResponse>;
+    create(params: GenerateVoiceParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<VoiceGenerationResponse>;
+}
+
+declare class CheckVoice {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: CheckVoiceParams, options?: RequestOptions): Promise<CheckVoiceResponse>;
+}
+
 /**
  * Suno API client.
  *
@@ -500,8 +635,6 @@ declare class BoostStyle {
  * });
  *
  * const result = await client.textToMusic.run({
- *   custom_mode: false,
- *   instrumental: false,
  *   prompt: 'A chill lo-fi beat with soft vocals',
  *   model: 'suno-v4.5-plus',
  * });
@@ -525,7 +658,11 @@ declare class SunoClient {
     readonly textToSound: TextToSound;
     readonly generatePersona: GeneratePersona;
     readonly boostStyle: BoostStyle;
+    readonly voiceToValidationPhrase: VoiceToValidationPhrase;
+    readonly regenerateValidationPhrase: RegenerateValidationPhrase;
+    readonly generateVoice: GenerateVoice;
+    readonly checkVoice: CheckVoice;
     constructor(options?: ClientOptions);
 }
 
-export { type AddInstrumentalParams, type AddInstrumentalResponse, type AddVocalsParams, type AddVocalsResponse, type AlignedWord, type AsyncTaskResponse, type Audio, type BoostStyleParams, type BoostStyleResponse, 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 CompletedVisualizeMusicResponse, type ConvertAudioParams, type ConvertAudioResponse, type CoverAudioCustomParams, type CoverAudioParams, type CoverAudioResponse, type CoverAudioSimpleParams, type CreateMashupCustomParams, type CreateMashupParams, type CreateMashupResponse, type CreateMashupSimpleParams, type ExtendMusicParams, type ExtendMusicResponse, type GenerateArtworkParams, type GenerateArtworkResponse, type GenerateLyricsParams, type GenerateLyricsResponse, type GenerateMidiParams, type GenerateMidiResponse, type GeneratePersonaParams, type GeneratePersonaResponse, type GenerationStage, type GetTimestampedLyricsParams, type GetTimestampedLyricsResponse, type MidiInstrument, type MidiNote, type Persona, type PersonaModel, type ReplaceSectionParams, type ReplaceSectionResponse, type SeparateAudioStemsParams, type SeparateAudioStemsResponse, type SeparatedAudio, type SoundKey, type SoundModel, type SunoBaseParams, SunoClient, type SunoModel, type TaskCreateResponse, type TaskStatus, type TextToMusicCustomParams, type TextToMusicParams, type TextToMusicResponse, type TextToMusicSimpleParams, type TextToSoundParams, type TextToSoundResponse, type VisualizeMusicParams, type VisualizeMusicResponse, type VocalGender };
+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 };

package/dist/index.js

@@ -20,23 +20,23 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  AuthenticationError: () => import_core19.AuthenticationError,
-  InsufficientCreditsError: () => import_core19.InsufficientCreditsError,
-  NetworkError: () => import_core19.NetworkError,
-  NotFoundError: () => import_core19.NotFoundError,
-  RateLimitError: () => import_core19.RateLimitError,
-  RunApiError: () => import_core19.RunApiError,
-  ServiceUnavailableError: () => import_core19.ServiceUnavailableError,
+  AuthenticationError: () => import_core23.AuthenticationError,
+  InsufficientCreditsError: () => import_core23.InsufficientCreditsError,
+  NetworkError: () => import_core23.NetworkError,
+  NotFoundError: () => import_core23.NotFoundError,
+  RateLimitError: () => import_core23.RateLimitError,
+  RunApiError: () => import_core23.RunApiError,
+  ServiceUnavailableError: () => import_core23.ServiceUnavailableError,
   SunoClient: () => SunoClient,
-  TaskFailedError: () => import_core19.TaskFailedError,
-  TaskTimeoutError: () => import_core19.TaskTimeoutError,
-  TimeoutError: () => import_core19.TimeoutError,
-  ValidationError: () => import_core19.ValidationError
+  TaskFailedError: () => import_core23.TaskFailedError,
+  TaskTimeoutError: () => import_core23.TaskTimeoutError,
+  TimeoutError: () => import_core23.TimeoutError,
+  ValidationError: () => import_core23.ValidationError
 });
 module.exports = __toCommonJS(index_exports);
 
 // src/client.ts
-var import_core18 = require("@runapi.ai/core");
+var import_core22 = require("@runapi.ai/core");
 
 // src/resources/text-to-music.ts
 var import_core = require("@runapi.ai/core");
@@ -506,6 +506,112 @@ var BoostStyle = class {
   }
 };
 
+// src/resources/voice-to-validation-phrase.ts
+var import_core18 = require("@runapi.ai/core");
+var import_internal15 = require("@runapi.ai/core/internal");
+var ENDPOINT18 = "/api/v1/suno/voice_to_validation_phrase";
+var VoiceToValidationPhrase = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  async run(params, options) {
+    const { id } = await this.create(params, options);
+    const response = await (0, import_internal15.pollUntilComplete)(() => this.get(id, options), {
+      maxWaitMs: options?.maxWaitMs,
+      pollIntervalMs: options?.pollIntervalMs
+    });
+    return response;
+  }
+  async create(params, options) {
+    return this.http.request("POST", ENDPOINT18, {
+      body: (0, import_core18.compactParams)(params),
+      ...options
+    });
+  }
+  async get(id, options) {
+    return this.http.request("GET", `${ENDPOINT18}/${id}`, {
+      ...options
+    });
+  }
+};
+
+// src/resources/regenerate-validation-phrase.ts
+var import_core19 = require("@runapi.ai/core");
+var import_internal16 = require("@runapi.ai/core/internal");
+var ENDPOINT19 = "/api/v1/suno/regenerate_validation_phrase";
+var RegenerateValidationPhrase = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  async run(params, options) {
+    const { id } = await this.create(params, options);
+    const response = await (0, import_internal16.pollUntilComplete)(() => this.get(id, options), {
+      maxWaitMs: options?.maxWaitMs,
+      pollIntervalMs: options?.pollIntervalMs
+    });
+    return response;
+  }
+  async create(params, options) {
+    return this.http.request("POST", ENDPOINT19, {
+      body: (0, import_core19.compactParams)(params),
+      ...options
+    });
+  }
+  async get(id, options) {
+    return this.http.request("GET", `${ENDPOINT19}/${id}`, {
+      ...options
+    });
+  }
+};
+
+// src/resources/generate-voice.ts
+var import_core20 = require("@runapi.ai/core");
+var import_internal17 = require("@runapi.ai/core/internal");
+var ENDPOINT20 = "/api/v1/suno/generate_voice";
+var GenerateVoice = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  async run(params, options) {
+    const { id } = await this.create(params, options);
+    const response = await (0, import_internal17.pollUntilComplete)(() => this.get(id, options), {
+      maxWaitMs: options?.maxWaitMs,
+      pollIntervalMs: options?.pollIntervalMs
+    });
+    return response;
+  }
+  async create(params, options) {
+    return this.http.request("POST", ENDPOINT20, {
+      body: (0, import_core20.compactParams)(params),
+      ...options
+    });
+  }
+  async get(id, options) {
+    return this.http.request("GET", `${ENDPOINT20}/${id}`, {
+      ...options
+    });
+  }
+};
+
+// src/resources/check-voice.ts
+var import_core21 = require("@runapi.ai/core");
+var ENDPOINT21 = "/api/v1/suno/check_voice";
+var CheckVoice = class {
+  constructor(http) {
+    this.http = http;
+  }
+  http;
+  async run(params, options) {
+    return this.http.request("POST", ENDPOINT21, {
+      body: (0, import_core21.compactParams)(params),
+      ...options
+    });
+  }
+};
+
 // src/client.ts
 var SunoClient = class {
   textToMusic;
@@ -525,8 +631,12 @@ var SunoClient = class {
   textToSound;
   generatePersona;
   boostStyle;
+  voiceToValidationPhrase;
+  regenerateValidationPhrase;
+  generateVoice;
+  checkVoice;
   constructor(options = {}) {
-    const http = (0, import_core18.createHttpClient)(options);
+    const http = (0, import_core22.createHttpClient)(options);
     this.textToMusic = new TextToMusic(http);
     this.extendMusic = new ExtendMusic(http);
     this.generateArtwork = new GenerateArtwork(http);
@@ -544,11 +654,15 @@ var SunoClient = class {
     this.textToSound = new TextToSound(http);
     this.generatePersona = new GeneratePersona(http);
     this.boostStyle = new BoostStyle(http);
+    this.voiceToValidationPhrase = new VoiceToValidationPhrase(http);
+    this.regenerateValidationPhrase = new RegenerateValidationPhrase(http);
+    this.generateVoice = new GenerateVoice(http);
+    this.checkVoice = new CheckVoice(http);
   }
 };
 
 // src/index.ts
-var import_core19 = require("@runapi.ai/core");
+var import_core23 = require("@runapi.ai/core");
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   AuthenticationError,