@runapi.ai/suno 0.2.1

package/dist/index.d.mts

@@ -0,0 +1,531 @@
+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 = 'V5_5' | 'V5' | 'V4_5PLUS' | 'V4_5ALL' | 'V4_5' | 'V4' | 'V3_5';
+type SoundModel = 'V5' | 'V5_5';
+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 TaskStatus = AsyncTaskStatus;
+type GenerationStage = 'text_generated' | 'first_audio_ready' | 'all_audios_ready' | 'failed';
+interface SunoBaseParams {
+    callback_url?: string;
+    model?: SunoModel;
+    vocal_gender?: VocalGender;
+    style_weight?: number;
+    weirdness_constraint?: number;
+    audio_weight?: number;
+}
+interface TextToMusicSimpleParams extends SunoBaseParams {
+    custom_mode: false;
+    instrumental: boolean;
+    prompt: string;
+}
+interface TextToMusicCustomParams extends SunoBaseParams {
+    custom_mode: true;
+    instrumental: boolean;
+    style: string;
+    title: string;
+    prompt?: string;
+    persona_id?: string;
+    persona_model?: PersonaModel;
+    negative_tags?: string;
+    duration?: number;
+    continue_at?: number;
+    endpoint?: string;
+}
+type TextToMusicParams = TextToMusicSimpleParams | TextToMusicCustomParams;
+interface ExtendMusicParams extends SunoBaseParams {
+    task_id?: string;
+    audio_id?: string;
+    audio_url?: string;
+    upload_url?: string;
+    default_param_flag?: boolean;
+    instrumental?: boolean;
+    prompt?: string;
+    style?: string;
+    title?: string;
+    continue_at?: number;
+    persona_id?: string;
+    persona_model?: PersonaModel;
+    model?: SunoModel;
+    negative_tags?: string;
+}
+interface GenerateArtworkParams {
+    task_id: string;
+    callback_url?: string;
+    [key: string]: unknown;
+}
+interface CoverAudioSimpleParams extends SunoBaseParams {
+    upload_url: string;
+    custom_mode: false;
+    instrumental: boolean;
+    prompt: string;
+    negative_tags?: string;
+}
+interface CoverAudioCustomParams extends SunoBaseParams {
+    upload_url: string;
+    custom_mode: true;
+    instrumental: boolean;
+    style: string;
+    title: string;
+    prompt?: string;
+    persona_id?: string;
+    persona_model?: PersonaModel;
+    negative_tags?: string;
+}
+type CoverAudioParams = CoverAudioSimpleParams | CoverAudioCustomParams;
+interface AddInstrumentalParams extends SunoBaseParams {
+    model?: SunoModel;
+    upload_url: string;
+    title: string;
+    negative_tags: string;
+    tags: string;
+}
+interface AddVocalsParams extends SunoBaseParams {
+    model?: SunoModel;
+    upload_url: string;
+    prompt: string;
+    title: string;
+    negative_tags: string;
+    style: string;
+}
+interface SeparateAudioStemsParams {
+    task_id: string;
+    audio_id: string;
+    type?: 'separate_vocal' | 'split_stem' | string;
+    callback_url?: string;
+}
+interface GenerateMidiParams {
+    task_id: string;
+    callback_url?: string;
+}
+interface ConvertAudioParams {
+    task_id: string;
+    audio_id?: string;
+    callback_url?: string;
+}
+interface VisualizeMusicParams {
+    task_id: string;
+    audio_id?: string;
+    prompt?: string;
+    callback_url?: string;
+    author?: string;
+    domain_name?: string;
+}
+interface GenerateLyricsParams {
+    prompt: string;
+    callback_url?: string;
+}
+interface GetTimestampedLyricsParams {
+    task_id: string;
+    audio_id: string;
+    callback_url?: string;
+}
+interface ReplaceSectionParams {
+    task_id: string;
+    audio_id: string;
+    prompt: string;
+    tags: string;
+    title: string;
+    infill_start_time: number;
+    infill_end_time: number;
+    callback_url?: string;
+    negative_tags?: string;
+    full_lyrics?: string;
+}
+interface GeneratePersonaParams {
+    task_id: string;
+    audio_id: string;
+    name: string;
+    description: string;
+}
+interface BoostStyleParams {
+    description: string;
+    name?: string;
+}
+interface TextToSoundParams {
+    callback_url?: string;
+    model: SoundModel;
+    prompt: string;
+    sound_loop?: boolean;
+    sound_tempo?: number;
+    sound_key?: SoundKey;
+    grab_lyrics?: boolean;
+}
+interface CreateMashupSimpleParams extends SunoBaseParams {
+    upload_url_list: [string, string];
+    custom_mode: false;
+    model?: SunoModel;
+    prompt: string;
+    instrumental?: boolean;
+}
+interface CreateMashupCustomParams extends SunoBaseParams {
+    upload_url_list: [string, string];
+    custom_mode: true;
+    model?: SunoModel;
+    style: string;
+    title: string;
+    prompt?: string;
+    instrumental?: boolean;
+}
+type CreateMashupParams = CreateMashupSimpleParams | CreateMashupCustomParams;
+interface TaskCreateResponse {
+    id: string;
+    status?: string;
+    [key: string]: unknown;
+}
+interface Audio {
+    id: string;
+    audio_url?: string;
+    stream_audio_url?: string;
+    image_url?: string;
+    prompt?: string;
+    model_name?: string;
+    title?: string;
+    tags?: string[];
+    duration?: number;
+    [key: string]: unknown;
+}
+interface AsyncTaskResponse {
+    id: string;
+    status: TaskStatus;
+    generation_stage?: GenerationStage;
+    error?: string;
+    [key: string]: unknown;
+}
+interface TextToMusicResponse extends AsyncTaskResponse {
+    audios?: Audio[];
+}
+interface ExtendMusicResponse extends AsyncTaskResponse {
+    original_task_id?: string;
+    audios?: Audio[];
+}
+interface GenerateArtworkResponse extends AsyncTaskResponse {
+    covers?: Array<{
+        url: string;
+    }>;
+}
+interface CoverAudioResponse extends AsyncTaskResponse {
+    audios?: Audio[];
+}
+interface AddInstrumentalResponse extends TextToMusicResponse {
+}
+interface AddVocalsResponse extends TextToMusicResponse {
+}
+interface TextToSoundResponse extends TextToMusicResponse {
+}
+interface SeparatedAudio {
+    vocal_url?: string;
+    instrumental_url?: string;
+    backing_vocals_url?: string;
+    bass_url?: string;
+    brass_url?: string;
+    drums_url?: string;
+    fx_url?: string;
+    guitar_url?: string;
+    keyboard_url?: string;
+    percussion_url?: string;
+    piano_url?: string;
+    strings_url?: string;
+    synth_url?: string;
+    woodwinds_url?: string;
+}
+interface SeparateAudioStemsResponse extends AsyncTaskResponse {
+    separated_audios?: SeparatedAudio;
+}
+interface MidiNote {
+    pitch: number;
+    start_time: number;
+    end_time: number;
+    velocity: number;
+}
+interface MidiInstrument {
+    name: string;
+    notes: MidiNote[];
+}
+interface GenerateMidiResponse extends AsyncTaskResponse {
+    instruments?: MidiInstrument[];
+}
+interface ConvertAudioResponse extends AsyncTaskResponse {
+    wav_url?: string;
+    original_task_id?: string;
+}
+interface VisualizeMusicResponse extends AsyncTaskResponse {
+    video_url?: string;
+    original_task_id?: string;
+}
+interface GenerateLyricsResponse extends AsyncTaskResponse {
+    lyrics?: Array<{
+        title?: string;
+        text: string;
+    }>;
+}
+interface AlignedWord {
+    word: string;
+    success: boolean;
+    start_time: number;
+    end_time: number;
+    palign: number;
+}
+interface GetTimestampedLyricsResponse {
+    aligned_words?: AlignedWord[];
+    waveform_data?: number[];
+    hoot_cer?: number;
+    is_streamed?: boolean;
+    [key: string]: unknown;
+}
+interface ReplaceSectionResponse extends AsyncTaskResponse {
+    track?: Audio;
+}
+interface Persona {
+    id: string;
+    name: string;
+    description: string;
+    [key: string]: unknown;
+}
+interface GeneratePersonaResponse {
+    persona: Persona;
+    error?: string;
+    [key: string]: unknown;
+}
+interface BoostStyleResponse {
+    style: string;
+    error?: string;
+    [key: string]: unknown;
+}
+interface CreateMashupResponse extends AsyncTaskResponse {
+    audios?: Audio[];
+}
+type CompletedTextToMusicResponse = TextToMusicResponse & {
+    status: 'completed';
+    audios: Audio[];
+};
+type CompletedExtendMusicResponse = ExtendMusicResponse & {
+    status: 'completed';
+    audios: Audio[];
+};
+type CompletedGenerateArtworkResponse = GenerateArtworkResponse & {
+    status: 'completed';
+    covers: Array<{
+        url: string;
+    }>;
+};
+type CompletedCoverAudioResponse = CoverAudioResponse & {
+    status: 'completed';
+    audios: Audio[];
+};
+type CompletedAddInstrumentalResponse = AddInstrumentalResponse & {
+    status: 'completed';
+    audios: Audio[];
+};
+type CompletedAddVocalsResponse = AddVocalsResponse & {
+    status: 'completed';
+    audios: Audio[];
+};
+type CompletedSeparateAudioStemsResponse = SeparateAudioStemsResponse & {
+    status: 'completed';
+    separated_audios: SeparatedAudio;
+};
+type CompletedGenerateMidiResponse = GenerateMidiResponse & {
+    status: 'completed';
+    instruments: MidiInstrument[];
+};
+type CompletedConvertAudioResponse = ConvertAudioResponse & {
+    status: 'completed';
+    wav_url: string;
+};
+type CompletedVisualizeMusicResponse = VisualizeMusicResponse & {
+    status: 'completed';
+    video_url: string;
+};
+type CompletedGenerateLyricsResponse = GenerateLyricsResponse & {
+    status: 'completed';
+    lyrics: Array<{
+        title?: string;
+        text: string;
+    }>;
+};
+type CompletedReplaceSectionResponse = ReplaceSectionResponse & {
+    status: 'completed';
+    track: Audio;
+};
+type CompletedCreateMashupResponse = CreateMashupResponse & {
+    status: 'completed';
+    audios: Audio[];
+};
+type CompletedTextToSoundResponse = TextToSoundResponse & {
+    status: 'completed';
+    audios: Audio[];
+};
+
+declare class TextToMusic {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: TextToMusicParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToMusicResponse>;
+    create(params: TextToMusicParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<TextToMusicResponse>;
+}
+
+declare class ExtendMusic {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: ExtendMusicParams, options?: RequestOptions & PollingOptions): Promise<CompletedExtendMusicResponse>;
+    create(params: ExtendMusicParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<ExtendMusicResponse>;
+}
+
+declare class GenerateArtwork {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: GenerateArtworkParams, options?: RequestOptions & PollingOptions): Promise<CompletedGenerateArtworkResponse>;
+    create(params: GenerateArtworkParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<GenerateArtworkResponse>;
+}
+
+declare class CoverAudio {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: CoverAudioParams, options?: RequestOptions & PollingOptions): Promise<CompletedCoverAudioResponse>;
+    create(params: CoverAudioParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<CoverAudioResponse>;
+}
+
+declare class AddInstrumental {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: AddInstrumentalParams, options?: RequestOptions & PollingOptions): Promise<CompletedAddInstrumentalResponse>;
+    create(params: AddInstrumentalParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<AddInstrumentalResponse>;
+}
+
+declare class AddVocals {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: AddVocalsParams, options?: RequestOptions & PollingOptions): Promise<CompletedAddVocalsResponse>;
+    create(params: AddVocalsParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<AddVocalsResponse>;
+}
+
+declare class SeparateAudioStems {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: SeparateAudioStemsParams, options?: RequestOptions & PollingOptions): Promise<CompletedSeparateAudioStemsResponse>;
+    create(params: SeparateAudioStemsParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<SeparateAudioStemsResponse>;
+}
+
+declare class GenerateMidi {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: GenerateMidiParams, options?: RequestOptions & PollingOptions): Promise<CompletedGenerateMidiResponse>;
+    create(params: GenerateMidiParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<GenerateMidiResponse>;
+}
+
+declare class ConvertAudio {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: ConvertAudioParams, options?: RequestOptions & PollingOptions): Promise<CompletedConvertAudioResponse>;
+    create(params: ConvertAudioParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<ConvertAudioResponse>;
+}
+
+declare class VisualizeMusic {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: VisualizeMusicParams, options?: RequestOptions & PollingOptions): Promise<CompletedVisualizeMusicResponse>;
+    create(params: VisualizeMusicParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<VisualizeMusicResponse>;
+}
+
+declare class GenerateLyrics {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: GenerateLyricsParams, options?: RequestOptions & PollingOptions): Promise<CompletedGenerateLyricsResponse>;
+    create(params: GenerateLyricsParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<GenerateLyricsResponse>;
+}
+
+declare class GetTimestampedLyrics {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: GetTimestampedLyricsParams, options?: RequestOptions): Promise<GetTimestampedLyricsResponse>;
+}
+
+declare class ReplaceSection {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: ReplaceSectionParams, options?: RequestOptions & PollingOptions): Promise<CompletedReplaceSectionResponse>;
+    create(params: ReplaceSectionParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<ReplaceSectionResponse>;
+}
+
+declare class CreateMashup {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: CreateMashupParams, options?: RequestOptions & PollingOptions): Promise<CompletedCreateMashupResponse>;
+    create(params: CreateMashupParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<CreateMashupResponse>;
+}
+
+declare class TextToSound {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: TextToSoundParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToSoundResponse>;
+    create(params: TextToSoundParams, options?: RequestOptions): Promise<TaskCreateResponse>;
+    get(id: string, options?: RequestOptions): Promise<TextToSoundResponse>;
+}
+
+declare class GeneratePersona {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: GeneratePersonaParams, options?: RequestOptions): Promise<GeneratePersonaResponse>;
+}
+
+declare class BoostStyle {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(params: BoostStyleParams, options?: RequestOptions): Promise<BoostStyleResponse>;
+}
+
+/**
+ * Suno API client.
+ *
+ * @example
+ * ```typescript
+ * const client = new SunoClient({
+ *   apiKey: 'your-api-key',
+ *   baseUrl: 'https://runapi.ai',
+ * });
+ *
+ * const result = await client.textToMusic.run({
+ *   custom_mode: false,
+ *   instrumental: false,
+ *   prompt: 'A chill lo-fi beat with soft vocals',
+ *   model: 'V4_5PLUS',
+ * });
+ * ```
+ */
+declare class SunoClient {
+    readonly textToMusic: TextToMusic;
+    readonly extendMusic: ExtendMusic;
+    readonly generateArtwork: GenerateArtwork;
+    readonly coverAudio: CoverAudio;
+    readonly addInstrumental: AddInstrumental;
+    readonly addVocals: AddVocals;
+    readonly separateAudioStems: SeparateAudioStems;
+    readonly generateMidi: GenerateMidi;
+    readonly convertAudio: ConvertAudio;
+    readonly visualizeMusic: VisualizeMusic;
+    readonly generateLyrics: GenerateLyrics;
+    readonly getTimestampedLyrics: GetTimestampedLyrics;
+    readonly replaceSection: ReplaceSection;
+    readonly createMashup: CreateMashup;
+    readonly textToSound: TextToSound;
+    readonly generatePersona: GeneratePersona;
+    readonly boostStyle: BoostStyle;
+    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 };