@runapi.ai/suno 0.2.6 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -1,32 +1,57 @@
1
- import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, ClientOptions } from '@runapi.ai/core';
1
+ import { AsyncTaskStatus, HttpClient, RequestOptions, PollingOptions, BaseClient, ClientOptions } from '@runapi.ai/core';
2
2
  export { AuthenticationError, InsufficientCreditsError, NetworkError, NotFoundError, RateLimitError, RunApiError, ServiceUnavailableError, TaskFailedError, TaskTimeoutError, TimeoutError, ValidationError } from '@runapi.ai/core';
3
3
 
4
+ /** Suno music generation engine version. V5.5 has highest quality; V4 is the earliest available. */
4
5
  type SunoModel = 'suno-v5.5' | 'suno-v5' | 'suno-v4.5-plus' | 'suno-v4.5-all' | 'suno-v4.5' | 'suno-v4';
6
+ /** Model versions that support sound effect generation (subset of SunoModel). */
5
7
  type SoundModel = 'suno-v5' | 'suno-v5.5';
8
+ /** Language for the voice-cloning validation phrase the user must read back. */
6
9
  type ValidationPhraseLanguage = 'en' | 'zh' | 'es' | 'fr' | 'pt' | 'de' | 'ja' | 'ko' | 'hi' | 'ru';
10
+ /** Musical key for sound effect generation (major and minor keys). */
7
11
  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';
8
12
  type VocalGender = 'male' | 'female';
13
+ /** `style` applies genre/mood without changing the voice; `voice` applies cloned voice characteristics. */
9
14
  type PersonaType = 'style' | 'voice';
15
+ /** `source` inherits style/title/continue_at from the original track; `custom` requires explicit values. */
10
16
  type ParameterMode = 'source' | 'custom';
17
+ /**
18
+ * Controls how vocals are generated.
19
+ * - `auto_lyrics`: generates lyrics automatically from the `prompt` field
20
+ * - `exact_lyrics`: sings the exact text in the `lyrics` field
21
+ * - `instrumental`: produces music with no vocals
22
+ */
11
23
  type VocalMode = 'auto_lyrics' | 'exact_lyrics' | 'instrumental';
12
24
  type TaskStatus = AsyncTaskStatus;
25
+ /** Progress phase of a multi-step music generation task. */
13
26
  type GenerationStage = 'text_generated' | 'first_audio_ready' | 'all_audios_ready' | 'failed';
27
+ /** Singing ability of the voice being cloned; calibrates model expectations during voice generation. */
14
28
  type SingerSkillLevel = 'beginner' | 'intermediate' | 'advanced' | 'professional';
29
+ /**
30
+ * Fields shared across most Suno music generation endpoints.
31
+ * `style_weight`, `weirdness_constraint`, and `audio_weight` are 0-1 knobs (2 decimal places)
32
+ * that tune style adherence, creative deviation, and audio fidelity respectively.
33
+ */
15
34
  interface SunoBaseParams {
16
35
  callback_url?: string;
17
36
  model?: SunoModel;
18
37
  vocal_gender?: VocalGender;
38
+ /** 0-1; higher values enforce stricter style adherence. */
19
39
  style_weight?: number;
40
+ /** 0-1; higher values allow more creative deviation from the prompt. */
20
41
  weirdness_constraint?: number;
42
+ /** 0-1; higher values prioritize audio fidelity over stylistic variation. */
21
43
  audio_weight?: number;
22
44
  }
45
+ /** Auto-lyrics variant: generates lyrics automatically from `prompt`. */
23
46
  interface TextToMusicPromptParams extends SunoBaseParams {
24
47
  vocal_mode: 'auto_lyrics';
48
+ /** Song brief used for automatic lyrics generation. */
25
49
  prompt: string;
26
50
  lyrics?: never;
27
51
  style?: never;
28
52
  title?: never;
29
53
  }
54
+ /** Exact-lyrics variant: sings the literal `lyrics` text with explicit style/title. */
30
55
  interface TextToMusicLyricsParams extends SunoBaseParams {
31
56
  vocal_mode: 'exact_lyrics';
32
57
  prompt?: never;
@@ -35,11 +60,14 @@ interface TextToMusicLyricsParams extends SunoBaseParams {
35
60
  title: string;
36
61
  persona_id?: string;
37
62
  persona_type?: PersonaType;
63
+ /** Styles to avoid (e.g. "heavy metal, screamo"). */
38
64
  negative_tags?: string;
39
65
  duration_seconds?: number;
66
+ /** Timestamp in seconds to continue generation from. */
40
67
  continue_at?: number;
41
68
  endpoint?: string;
42
69
  }
70
+ /** Instrumental variant: produces music with no vocals. Requires explicit style/title. */
43
71
  interface TextToMusicInstrumentalParams extends SunoBaseParams {
44
72
  vocal_mode: 'instrumental';
45
73
  prompt?: never;
@@ -53,30 +81,49 @@ interface TextToMusicInstrumentalParams extends SunoBaseParams {
53
81
  continue_at?: number;
54
82
  endpoint?: string;
55
83
  }
84
+ /**
85
+ * Params for text-to-music generation. The discriminated union on `vocal_mode` determines
86
+ * which fields are required: `auto_lyrics` needs `prompt`, `exact_lyrics` needs `lyrics` + `style` + `title`,
87
+ * and `instrumental` needs `style` + `title`.
88
+ */
56
89
  type TextToMusicParams = TextToMusicPromptParams | TextToMusicLyricsParams | TextToMusicInstrumentalParams;
90
+ /**
91
+ * Params for extending an existing track from a specified timestamp.
92
+ * Provide exactly one source: `task_id`, `audio_id`, `audio_url`, or `upload_url`.
93
+ * `parameter_mode` controls whether to inherit the source track's settings (`source`)
94
+ * or override style, title, and continue_at (`custom`).
95
+ */
57
96
  interface ExtendMusicParams extends SunoBaseParams {
58
97
  task_id?: string;
59
98
  audio_id?: string;
60
99
  audio_url?: string;
61
100
  upload_url?: string;
62
101
  parameter_mode: ParameterMode;
102
+ /** When true, produces an instrumental extension with no vocals. */
63
103
  instrumental?: boolean;
64
104
  prompt?: string;
65
105
  lyrics?: string;
106
+ /** Required when parameter_mode is `custom`. */
66
107
  style?: string;
108
+ /** Required when parameter_mode is `custom`. Max ~80-100 characters. */
67
109
  title?: string;
110
+ /** Required when parameter_mode is `custom`. Seconds, must be > 0 and < source duration. */
68
111
  continue_at?: number;
69
112
  persona_id?: string;
70
113
  persona_type?: PersonaType;
71
114
  model?: SunoModel;
72
115
  negative_tags?: string;
73
116
  }
117
+ /** Params for generating cover artwork for an existing music task. */
74
118
  interface GenerateArtworkParams {
119
+ /** Source music task ID to generate artwork for. */
75
120
  task_id: string;
76
121
  callback_url?: string;
77
122
  [key: string]: unknown;
78
123
  }
124
+ /** Cover audio with auto-generated lyrics from a prompt. */
79
125
  interface CoverAudioPromptParams extends SunoBaseParams {
126
+ /** URL of the audio file to re-record vocals over. */
80
127
  upload_url: string;
81
128
  vocal_mode: 'auto_lyrics';
82
129
  prompt: string;
@@ -85,6 +132,7 @@ interface CoverAudioPromptParams extends SunoBaseParams {
85
132
  title?: never;
86
133
  negative_tags?: string;
87
134
  }
135
+ /** Cover audio with exact lyrics sung over the uploaded track. */
88
136
  interface CoverAudioLyricsParams extends SunoBaseParams {
89
137
  upload_url: string;
90
138
  vocal_mode: 'exact_lyrics';
@@ -96,6 +144,7 @@ interface CoverAudioLyricsParams extends SunoBaseParams {
96
144
  persona_type?: PersonaType;
97
145
  negative_tags?: string;
98
146
  }
147
+ /** Cover audio as instrumental (no vocals) over the uploaded track. */
99
148
  interface CoverAudioInstrumentalParams extends SunoBaseParams {
100
149
  upload_url: string;
101
150
  vocal_mode: 'instrumental';
@@ -107,98 +156,179 @@ interface CoverAudioInstrumentalParams extends SunoBaseParams {
107
156
  persona_type?: PersonaType;
108
157
  negative_tags?: string;
109
158
  }
159
+ /**
160
+ * Params for re-recording vocals over an uploaded audio file. Discriminated on `vocal_mode`
161
+ * the same way as {@link TextToMusicParams}.
162
+ */
110
163
  type CoverAudioParams = CoverAudioPromptParams | CoverAudioLyricsParams | CoverAudioInstrumentalParams;
164
+ /**
165
+ * Params for generating and adding an instrumental backing track to uploaded audio.
166
+ * `tags` and `negative_tags` control the generated style; pass empty strings if no preference.
167
+ */
111
168
  interface AddInstrumentalParams extends SunoBaseParams {
112
169
  model?: SunoModel;
113
170
  upload_url: string;
114
171
  title: string;
172
+ /** Styles to avoid (required, but can be empty string). */
115
173
  negative_tags: string;
174
+ /** Style/genre tags for the generated instrumental. */
116
175
  tags: string;
117
176
  }
177
+ /** Params for generating and adding vocals to an uploaded instrumental track. */
118
178
  interface AddVocalsParams extends SunoBaseParams {
119
179
  model?: SunoModel;
120
180
  upload_url: string;
181
+ /** Vocal lyrics to sing over the instrumental. */
121
182
  lyrics: string;
122
183
  title: string;
184
+ /** Styles to avoid (required, but can be empty string). */
123
185
  negative_tags: string;
124
186
  style: string;
125
187
  }
188
+ /** Params for splitting a track into individual instrument stems (vocals, drums, bass, etc.). */
126
189
  interface SeparateAudioStemsParams {
127
190
  task_id: string;
128
191
  audio_id: string;
192
+ /** `separate_vocal` isolates vocals+instrumental; `split_stem` splits into all individual instruments. */
129
193
  type?: 'separate_vocal' | 'split_stem' | string;
130
194
  callback_url?: string;
131
195
  }
196
+ /** Params for extracting per-instrument MIDI note data from a generated track. */
132
197
  interface GenerateMidiParams {
133
198
  task_id: string;
134
199
  callback_url?: string;
135
200
  }
201
+ /** Params for converting a generated track to WAV format. */
136
202
  interface ConvertAudioParams {
137
203
  task_id: string;
138
204
  audio_id?: string;
139
205
  callback_url?: string;
140
206
  }
207
+ /** Params for generating a music visualization video from an existing track. */
141
208
  interface VisualizeMusicParams {
142
209
  task_id: string;
143
210
  audio_id?: string;
144
211
  prompt?: string;
145
212
  callback_url?: string;
213
+ /** Author name displayed in the visualization video. */
146
214
  author?: string;
215
+ /** Domain name watermark overlaid on the video. */
147
216
  domain_name?: string;
148
217
  }
218
+ /** Params for AI-powered lyrics generation from a text prompt. */
149
219
  interface GenerateLyricsParams {
150
220
  prompt: string;
151
221
  callback_url?: string;
152
222
  }
223
+ /** Params for retrieving word-level timing alignment for a track. Synchronous -- use `run()` directly. */
153
224
  interface GetTimestampedLyricsParams {
154
225
  task_id: string;
155
226
  audio_id: string;
156
227
  callback_url?: string;
157
228
  }
158
- interface ReplaceSectionParams {
159
- task_id: string;
160
- audio_id: string;
229
+ interface ReplaceSectionBaseParams {
230
+ /** Replacement lyrics for the specified section. */
161
231
  lyrics: string;
232
+ /** Style/genre tags for the replacement section. */
162
233
  tags: string;
163
234
  title: string;
235
+ /** Section start time in seconds. The replacement window must be 6-60 seconds. */
164
236
  infill_start_time: number;
237
+ /** Section end time in seconds; must be greater than infill_start_time. */
165
238
  infill_end_time: number;
166
239
  callback_url?: string;
167
240
  negative_tags?: string;
168
- full_lyrics?: string;
241
+ /** Complete song lyrics for context; helps maintain coherence across sections. */
242
+ full_lyrics: string;
243
+ }
244
+ /** Replace a section using an existing generated audio track. */
245
+ interface ReplaceSectionExistingAudioParams extends ReplaceSectionBaseParams {
246
+ task_id: string;
247
+ audio_id: string;
248
+ upload_url?: never;
249
+ model?: never;
250
+ }
251
+ /** Replace a section using an uploaded source audio file. */
252
+ interface ReplaceSectionUploadedAudioParams extends ReplaceSectionBaseParams {
253
+ upload_url: string;
254
+ model: SunoModel;
255
+ task_id?: never;
256
+ audio_id?: never;
169
257
  }
258
+ /**
259
+ * Params for re-generating a time range within a track with new lyrics and style.
260
+ * Provide either `task_id` + `audio_id` for an existing generated track, or `upload_url` + `model` for uploaded audio.
261
+ */
262
+ type ReplaceSectionParams = ReplaceSectionExistingAudioParams | ReplaceSectionUploadedAudioParams;
263
+ /**
264
+ * Params for creating a reusable persona from an existing track's vocals.
265
+ * The persona can be referenced by ID in subsequent generation params. Synchronous -- use `run()` directly.
266
+ */
170
267
  interface GeneratePersonaParams {
268
+ /** Source task ID containing reference vocals. */
171
269
  task_id: string;
172
270
  audio_id: string;
173
271
  name: string;
174
272
  description: string;
175
273
  }
274
+ /**
275
+ * Params for generating style/genre tags from a text description.
276
+ * Useful for filling `style` fields in other params. Synchronous -- use `run()` directly.
277
+ */
176
278
  interface BoostStyleParams {
279
+ /** Style description to generate tags from (e.g. "upbeat summer pop with acoustic guitar"). */
177
280
  description: string;
178
281
  name?: string;
179
282
  }
283
+ /**
284
+ * Params for sound effect generation (not music -- use {@link TextToMusicParams} for songs).
285
+ * Supports loopable audio, BPM control, and musical key selection.
286
+ */
180
287
  interface TextToSoundParams {
181
288
  callback_url?: string;
182
289
  model: SoundModel;
290
+ /** Sound description, max 500 characters. */
183
291
  prompt: string;
292
+ /** When true, generates seamlessly loopable audio. */
184
293
  sound_loop?: boolean;
294
+ /** BPM (1-300) for rhythmic sound effects. */
185
295
  sound_tempo?: number;
186
296
  sound_key?: SoundKey;
297
+ /** When true, captures lyric subtitles from the generated audio. */
187
298
  grab_lyrics?: boolean;
188
299
  }
300
+ /**
301
+ * Step 1 of voice cloning: upload a voice recording and specify vocal segment boundaries.
302
+ * Returns a validation phrase the user must re-record and submit via {@link GenerateVoiceParams}.
303
+ *
304
+ * Voice cloning workflow: VoiceToValidationPhrase -> RegenerateValidationPhrase (optional) -> GenerateVoice -> CheckVoice.
305
+ */
189
306
  interface VoiceToValidationPhraseParams {
307
+ /** URL of the source voice recording. */
190
308
  voice_url: string;
309
+ /** Start of the vocal segment in the recording (seconds). */
191
310
  vocal_start_seconds: number;
311
+ /** End of the vocal segment in the recording (seconds). */
192
312
  vocal_end_seconds: number;
193
313
  language?: ValidationPhraseLanguage;
194
314
  callback_url?: string;
195
315
  }
316
+ /**
317
+ * Step 2 (optional) of voice cloning: requests a new, easier validation phrase for an
318
+ * in-progress voice cloning task, if the original phrase was too difficult.
319
+ */
196
320
  interface RegenerateValidationPhraseParams {
321
+ /** Task ID from a prior VoiceToValidationPhrase call. */
197
322
  task_id: string;
198
323
  callback_url?: string;
199
324
  }
325
+ /**
326
+ * Step 3 of voice cloning: submits the user's recording of the validation phrase to train a custom voice.
327
+ * `task_id` is from the prior VoiceToValidationPhrase task; `verify_url` is the user's recording.
328
+ */
200
329
  interface GenerateVoiceParams {
201
330
  task_id: string;
331
+ /** URL of the user's recording of the validation phrase. */
202
332
  verify_url: string;
203
333
  voice_name?: string;
204
334
  description?: string;
@@ -206,10 +336,17 @@ interface GenerateVoiceParams {
206
336
  singer_skill_level?: SingerSkillLevel;
207
337
  callback_url?: string;
208
338
  }
339
+ /**
340
+ * Step 4 (final) of voice cloning: checks whether a custom voice from GenerateVoice is ready.
341
+ * Synchronous -- use `run()` directly.
342
+ */
209
343
  interface CheckVoiceParams {
344
+ /** Task ID from a prior GenerateVoice call. */
210
345
  task_id: string;
211
346
  }
347
+ /** Mashup with auto-generated lyrics. */
212
348
  interface CreateMashupPromptParams extends SunoBaseParams {
349
+ /** Exactly two audio URLs to blend into one composition. */
213
350
  upload_url_list: [string, string];
214
351
  model?: SunoModel;
215
352
  vocal_mode: 'auto_lyrics';
@@ -218,6 +355,7 @@ interface CreateMashupPromptParams extends SunoBaseParams {
218
355
  style?: never;
219
356
  title?: never;
220
357
  }
358
+ /** Mashup with exact lyrics sung over the blended tracks. */
221
359
  interface CreateMashupLyricsParams extends SunoBaseParams {
222
360
  upload_url_list: [string, string];
223
361
  model?: SunoModel;
@@ -229,6 +367,7 @@ interface CreateMashupLyricsParams extends SunoBaseParams {
229
367
  persona_id?: string;
230
368
  persona_type?: PersonaType;
231
369
  }
370
+ /** Mashup as instrumental (no vocals). */
232
371
  interface CreateMashupInstrumentalParams extends SunoBaseParams {
233
372
  upload_url_list: [string, string];
234
373
  model?: SunoModel;
@@ -240,29 +379,39 @@ interface CreateMashupInstrumentalParams extends SunoBaseParams {
240
379
  persona_id?: string;
241
380
  persona_type?: PersonaType;
242
381
  }
382
+ /**
383
+ * Params for blending exactly two audio tracks into a single new composition.
384
+ * Discriminated on `vocal_mode` the same way as {@link TextToMusicParams}.
385
+ */
243
386
  type CreateMashupParams = CreateMashupPromptParams | CreateMashupLyricsParams | CreateMashupInstrumentalParams;
387
+ /** Initial response from task creation with the assigned task ID. */
244
388
  interface TaskCreateResponse {
245
389
  id: string;
246
390
  status?: string;
247
391
  [key: string]: unknown;
248
392
  }
393
+ /** Metadata and URLs for a generated music track. */
249
394
  interface Audio {
250
395
  id: string;
251
396
  audio_url?: string;
397
+ /** Progressive streaming URL; available before the full file is ready. */
252
398
  stream_audio_url?: string;
253
399
  image_url?: string;
254
400
  lyrics?: string;
255
401
  model_name?: string;
256
402
  title?: string;
257
403
  tags?: string[];
404
+ /** Track duration in seconds. */
258
405
  duration?: number;
259
406
  [key: string]: unknown;
260
407
  }
408
+ /** Metadata and URLs for a generated sound effect (distinct from music {@link Audio}). */
261
409
  interface SoundAudio {
262
410
  id: string;
263
411
  audio_url?: string;
264
412
  stream_audio_url?: string;
265
413
  image_url?: string;
414
+ /** The prompt that was used to generate this sound effect. */
266
415
  prompt?: string;
267
416
  model_name?: string;
268
417
  title?: string;
@@ -270,6 +419,7 @@ interface SoundAudio {
270
419
  duration?: number;
271
420
  [key: string]: unknown;
272
421
  }
422
+ /** Base response for all Suno async tasks, carrying lifecycle status and generation progress. */
273
423
  interface AsyncTaskResponse {
274
424
  id: string;
275
425
  status: TaskStatus;
@@ -277,28 +427,36 @@ interface AsyncTaskResponse {
277
427
  error?: string;
278
428
  [key: string]: unknown;
279
429
  }
430
+ /** Result of a text-to-music generation task. */
280
431
  interface TextToMusicResponse extends AsyncTaskResponse {
281
432
  audios?: Audio[];
282
433
  }
434
+ /** Result of a music extension task. `original_task_id` references the source track. */
283
435
  interface ExtendMusicResponse extends AsyncTaskResponse {
284
436
  original_task_id?: string;
285
437
  audios?: Audio[];
286
438
  }
439
+ /** Result of an artwork generation task containing cover image URLs. */
287
440
  interface GenerateArtworkResponse extends AsyncTaskResponse {
288
441
  covers?: Array<{
289
442
  url: string;
290
443
  }>;
291
444
  }
445
+ /** Result of a cover audio task. */
292
446
  interface CoverAudioResponse extends AsyncTaskResponse {
293
447
  audios?: Audio[];
294
448
  }
449
+ /** Result of adding an instrumental backing track. */
295
450
  interface AddInstrumentalResponse extends TextToMusicResponse {
296
451
  }
452
+ /** Result of adding vocals to a track. */
297
453
  interface AddVocalsResponse extends TextToMusicResponse {
298
454
  }
455
+ /** Result of a sound effect generation task (uses {@link SoundAudio} instead of {@link Audio}). */
299
456
  interface TextToSoundResponse extends AsyncTaskResponse {
300
457
  audios?: SoundAudio[];
301
458
  }
459
+ /** URLs for each isolated instrument stem after separation. Only populated stems have URLs. */
302
460
  interface SeparatedAudio {
303
461
  vocal_url?: string;
304
462
  instrumental_url?: string;
@@ -315,80 +473,107 @@ interface SeparatedAudio {
315
473
  synth_url?: string;
316
474
  woodwinds_url?: string;
317
475
  }
476
+ /** Result of a stem separation task. */
318
477
  interface SeparateAudioStemsResponse extends AsyncTaskResponse {
319
478
  separated_audios?: SeparatedAudio;
320
479
  }
480
+ /** A single MIDI note event within an instrument track. */
321
481
  interface MidiNote {
482
+ /** MIDI pitch number (0-127). */
322
483
  pitch: number;
323
484
  start_time: number;
324
485
  end_time: number;
486
+ /** Note velocity (0-1 normalized). */
325
487
  velocity: number;
326
488
  }
489
+ /** All notes for a single instrument extracted from a track. */
327
490
  interface MidiInstrument {
328
491
  name: string;
329
492
  notes: MidiNote[];
330
493
  }
494
+ /** Result of a MIDI extraction task with per-instrument note data. */
331
495
  interface GenerateMidiResponse extends AsyncTaskResponse {
332
496
  instruments?: MidiInstrument[];
333
497
  }
498
+ /** Result of a WAV conversion task. */
334
499
  interface ConvertAudioResponse extends AsyncTaskResponse {
500
+ /** Download URL for the converted WAV file. */
335
501
  wav_url?: string;
336
502
  original_task_id?: string;
337
503
  }
504
+ /** Result of a music visualization task containing the generated video URL. */
338
505
  interface VisualizeMusicResponse extends AsyncTaskResponse {
339
506
  video_url?: string;
340
507
  original_task_id?: string;
341
508
  }
509
+ /** Result of a lyrics generation task with sectioned lyrics. */
342
510
  interface GenerateLyricsResponse extends AsyncTaskResponse {
511
+ /** Generated lyrics, split by section (e.g. "Chorus", "Verse 1"). */
343
512
  lyrics?: Array<{
344
513
  title?: string;
345
514
  text: string;
346
515
  }>;
347
516
  }
517
+ /** Word-level timing alignment for a single word in a track. */
348
518
  interface AlignedWord {
349
519
  word: string;
520
+ /** Whether alignment succeeded for this word. */
350
521
  success: boolean;
351
522
  start_time: number;
352
523
  end_time: number;
524
+ /** Alignment confidence score. */
353
525
  palign: number;
354
526
  }
527
+ /** Synchronous response containing word-level timing data and waveform for a track. */
355
528
  interface GetTimestampedLyricsResponse {
356
529
  aligned_words?: AlignedWord[];
530
+ /** Waveform amplitude data for visualization. */
357
531
  waveform_data?: number[];
532
+ /** Character error rate of the lyrics alignment. */
358
533
  hoot_cer?: number;
359
534
  is_streamed?: boolean;
360
535
  [key: string]: unknown;
361
536
  }
537
+ /** Result of a section replacement task. */
362
538
  interface ReplaceSectionResponse extends AsyncTaskResponse {
363
539
  track?: Audio;
364
540
  }
541
+ /** A reusable style or voice persona, referenced by ID in generation params. */
365
542
  interface Persona {
366
543
  id: string;
367
544
  name: string;
368
545
  description: string;
369
546
  [key: string]: unknown;
370
547
  }
548
+ /** Synchronous result of persona creation. */
371
549
  interface GeneratePersonaResponse {
372
550
  persona: Persona;
373
551
  error?: string;
374
552
  [key: string]: unknown;
375
553
  }
554
+ /** Synchronous result of style tag generation. `style` contains the generated tags string. */
376
555
  interface BoostStyleResponse {
377
556
  style: string;
378
557
  error?: string;
379
558
  [key: string]: unknown;
380
559
  }
560
+ /** Result of a mashup task. */
381
561
  interface CreateMashupResponse extends AsyncTaskResponse {
382
562
  audios?: Audio[];
383
563
  }
564
+ /** Result of a voice-cloning validation phrase task. The user must re-record this phrase. */
384
565
  interface ValidationPhraseResponse extends AsyncTaskResponse {
385
566
  provider_status?: string;
567
+ /** The validation phrase text the user must read back for voice cloning. */
386
568
  validation_phrase?: string;
387
569
  }
570
+ /** Result of a voice generation (training) task. `voice_id` is usable in subsequent generation params. */
388
571
  interface VoiceGenerationResponse extends AsyncTaskResponse {
389
572
  provider_status?: string;
573
+ /** Custom voice identifier, usable as persona in subsequent music generation. */
390
574
  voice_id?: string;
391
575
  }
576
+ /** Synchronous result indicating whether a custom voice is ready for use. */
392
577
  interface CheckVoiceResponse {
393
578
  is_available?: boolean;
394
579
  error?: string;
@@ -464,168 +649,520 @@ type CompletedVoiceGenerationResponse = VoiceGenerationResponse & {
464
649
  voice_id: string;
465
650
  };
466
651
 
652
+ /** Generates songs from a text prompt with configurable vocal mode, style, and persona. */
467
653
  declare class TextToMusic {
468
654
  private readonly http;
469
655
  constructor(http: HttpClient);
656
+ /**
657
+ * Create a text to music task and wait until complete.
658
+ * @param params Text to music parameters.
659
+ * @param options Per-request and polling overrides.
660
+ * @returns The completed text to music response.
661
+ */
470
662
  run(params: TextToMusicParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToMusicResponse>;
663
+ /**
664
+ * Create a text to music task; returns immediately with a task id.
665
+ * @param params Text to music parameters.
666
+ * @param options Per-request overrides.
667
+ * @returns The task creation result.
668
+ */
471
669
  create(params: TextToMusicParams, options?: RequestOptions): Promise<TaskCreateResponse>;
670
+ /**
671
+ * Fetch the current status of a text to music task.
672
+ * @param id The task id.
673
+ * @param options Per-request overrides.
674
+ * @returns The current text to music task status.
675
+ */
472
676
  get(id: string, options?: RequestOptions): Promise<TextToMusicResponse>;
473
677
  }
474
678
 
679
+ /** Continues an existing track from a specified timestamp, inheriting or overriding its settings. */
475
680
  declare class ExtendMusic {
476
681
  private readonly http;
477
682
  constructor(http: HttpClient);
683
+ /**
684
+ * Create an extend music task and wait until complete.
685
+ * @param params Extend music parameters.
686
+ * @param options Per-request and polling overrides.
687
+ * @returns The completed extend music response.
688
+ */
478
689
  run(params: ExtendMusicParams, options?: RequestOptions & PollingOptions): Promise<CompletedExtendMusicResponse>;
690
+ /**
691
+ * Create an extend music task; returns immediately with a task id.
692
+ * @param params Extend music parameters.
693
+ * @param options Per-request overrides.
694
+ * @returns The task creation result.
695
+ */
479
696
  create(params: ExtendMusicParams, options?: RequestOptions): Promise<TaskCreateResponse>;
697
+ /**
698
+ * Fetch the current status of an extend music task.
699
+ * @param id The task id.
700
+ * @param options Per-request overrides.
701
+ * @returns The current extend music task status.
702
+ */
480
703
  get(id: string, options?: RequestOptions): Promise<ExtendMusicResponse>;
481
704
  }
482
705
 
706
+ /** Creates cover artwork for an existing music task. */
483
707
  declare class GenerateArtwork {
484
708
  private readonly http;
485
709
  constructor(http: HttpClient);
710
+ /**
711
+ * Create a generate artwork task and wait until complete.
712
+ * @param params Generate artwork parameters.
713
+ * @param options Per-request and polling overrides.
714
+ * @returns The completed generate artwork response.
715
+ */
486
716
  run(params: GenerateArtworkParams, options?: RequestOptions & PollingOptions): Promise<CompletedGenerateArtworkResponse>;
717
+ /**
718
+ * Create a generate artwork task; returns immediately with a task id.
719
+ * @param params Generate artwork parameters.
720
+ * @param options Per-request overrides.
721
+ * @returns The task creation result.
722
+ */
487
723
  create(params: GenerateArtworkParams, options?: RequestOptions): Promise<TaskCreateResponse>;
724
+ /**
725
+ * Fetch the current status of a generate artwork task.
726
+ * @param id The task id.
727
+ * @param options Per-request overrides.
728
+ * @returns The current generate artwork task status.
729
+ */
488
730
  get(id: string, options?: RequestOptions): Promise<GenerateArtworkResponse>;
489
731
  }
490
732
 
733
+ /** Re-records vocals over an uploaded audio file with a new style or voice. */
491
734
  declare class CoverAudio {
492
735
  private readonly http;
493
736
  constructor(http: HttpClient);
737
+ /**
738
+ * Create a cover audio task and wait until complete.
739
+ * @param params Cover audio parameters.
740
+ * @param options Per-request and polling overrides.
741
+ * @returns The completed cover audio response.
742
+ */
494
743
  run(params: CoverAudioParams, options?: RequestOptions & PollingOptions): Promise<CompletedCoverAudioResponse>;
744
+ /**
745
+ * Create a cover audio task; returns immediately with a task id.
746
+ * @param params Cover audio parameters.
747
+ * @param options Per-request overrides.
748
+ * @returns The task creation result.
749
+ */
495
750
  create(params: CoverAudioParams, options?: RequestOptions): Promise<TaskCreateResponse>;
751
+ /**
752
+ * Fetch the current status of a cover audio task.
753
+ * @param id The task id.
754
+ * @param options Per-request overrides.
755
+ * @returns The current cover audio task status.
756
+ */
496
757
  get(id: string, options?: RequestOptions): Promise<CoverAudioResponse>;
497
758
  }
498
759
 
760
+ /** Generates and adds an instrumental backing track to uploaded audio. */
499
761
  declare class AddInstrumental {
500
762
  private readonly http;
501
763
  constructor(http: HttpClient);
764
+ /**
765
+ * Create an add instrumental task and wait until complete.
766
+ * @param params Add instrumental parameters.
767
+ * @param options Per-request and polling overrides.
768
+ * @returns The completed add instrumental response.
769
+ */
502
770
  run(params: AddInstrumentalParams, options?: RequestOptions & PollingOptions): Promise<CompletedAddInstrumentalResponse>;
771
+ /**
772
+ * Create an add instrumental task; returns immediately with a task id.
773
+ * @param params Add instrumental parameters.
774
+ * @param options Per-request overrides.
775
+ * @returns The task creation result.
776
+ */
503
777
  create(params: AddInstrumentalParams, options?: RequestOptions): Promise<TaskCreateResponse>;
778
+ /**
779
+ * Fetch the current status of an add instrumental task.
780
+ * @param id The task id.
781
+ * @param options Per-request overrides.
782
+ * @returns The current add instrumental task status.
783
+ */
504
784
  get(id: string, options?: RequestOptions): Promise<AddInstrumentalResponse>;
505
785
  }
506
786
 
787
+ /** Generates and adds vocals to an uploaded instrumental track. */
507
788
  declare class AddVocals {
508
789
  private readonly http;
509
790
  constructor(http: HttpClient);
791
+ /**
792
+ * Create an add vocals task and wait until complete.
793
+ * @param params Add vocals parameters.
794
+ * @param options Per-request and polling overrides.
795
+ * @returns The completed add vocals response.
796
+ */
510
797
  run(params: AddVocalsParams, options?: RequestOptions & PollingOptions): Promise<CompletedAddVocalsResponse>;
798
+ /**
799
+ * Create an add vocals task; returns immediately with a task id.
800
+ * @param params Add vocals parameters.
801
+ * @param options Per-request overrides.
802
+ * @returns The task creation result.
803
+ */
511
804
  create(params: AddVocalsParams, options?: RequestOptions): Promise<TaskCreateResponse>;
805
+ /**
806
+ * Fetch the current status of an add vocals task.
807
+ * @param id The task id.
808
+ * @param options Per-request overrides.
809
+ * @returns The current add vocals task status.
810
+ */
512
811
  get(id: string, options?: RequestOptions): Promise<AddVocalsResponse>;
513
812
  }
514
813
 
814
+ /** Splits a track into individual instrument stems (vocals, drums, bass, guitar, etc.). */
515
815
  declare class SeparateAudioStems {
516
816
  private readonly http;
517
817
  constructor(http: HttpClient);
818
+ /**
819
+ * Create a separate audio stems task and wait until complete.
820
+ * @param params Separate audio stems parameters.
821
+ * @param options Per-request and polling overrides.
822
+ * @returns The completed separate audio stems response.
823
+ */
518
824
  run(params: SeparateAudioStemsParams, options?: RequestOptions & PollingOptions): Promise<CompletedSeparateAudioStemsResponse>;
825
+ /**
826
+ * Create a separate audio stems task; returns immediately with a task id.
827
+ * @param params Separate audio stems parameters.
828
+ * @param options Per-request overrides.
829
+ * @returns The task creation result.
830
+ */
519
831
  create(params: SeparateAudioStemsParams, options?: RequestOptions): Promise<TaskCreateResponse>;
832
+ /**
833
+ * Fetch the current status of a separate audio stems task.
834
+ * @param id The task id.
835
+ * @param options Per-request overrides.
836
+ * @returns The current separate audio stems task status.
837
+ */
520
838
  get(id: string, options?: RequestOptions): Promise<SeparateAudioStemsResponse>;
521
839
  }
522
840
 
841
+ /** Extracts per-instrument MIDI note data from a generated track. */
523
842
  declare class GenerateMidi {
524
843
  private readonly http;
525
844
  constructor(http: HttpClient);
845
+ /**
846
+ * Create a generate midi task and wait until complete.
847
+ * @param params Generate midi parameters.
848
+ * @param options Per-request and polling overrides.
849
+ * @returns The completed generate midi response.
850
+ */
526
851
  run(params: GenerateMidiParams, options?: RequestOptions & PollingOptions): Promise<CompletedGenerateMidiResponse>;
852
+ /**
853
+ * Create a generate midi task; returns immediately with a task id.
854
+ * @param params Generate midi parameters.
855
+ * @param options Per-request overrides.
856
+ * @returns The task creation result.
857
+ */
527
858
  create(params: GenerateMidiParams, options?: RequestOptions): Promise<TaskCreateResponse>;
859
+ /**
860
+ * Fetch the current status of a generate midi task.
861
+ * @param id The task id.
862
+ * @param options Per-request overrides.
863
+ * @returns The current generate midi task status.
864
+ */
528
865
  get(id: string, options?: RequestOptions): Promise<GenerateMidiResponse>;
529
866
  }
530
867
 
868
+ /** Converts a generated track to WAV format. */
531
869
  declare class ConvertAudio {
532
870
  private readonly http;
533
871
  constructor(http: HttpClient);
872
+ /**
873
+ * Create a convert audio task and wait until complete.
874
+ * @param params Convert audio parameters.
875
+ * @param options Per-request and polling overrides.
876
+ * @returns The completed convert audio response.
877
+ */
534
878
  run(params: ConvertAudioParams, options?: RequestOptions & PollingOptions): Promise<CompletedConvertAudioResponse>;
879
+ /**
880
+ * Create a convert audio task; returns immediately with a task id.
881
+ * @param params Convert audio parameters.
882
+ * @param options Per-request overrides.
883
+ * @returns The task creation result.
884
+ */
535
885
  create(params: ConvertAudioParams, options?: RequestOptions): Promise<TaskCreateResponse>;
886
+ /**
887
+ * Fetch the current status of a convert audio task.
888
+ * @param id The task id.
889
+ * @param options Per-request overrides.
890
+ * @returns The current convert audio task status.
891
+ */
536
892
  get(id: string, options?: RequestOptions): Promise<ConvertAudioResponse>;
537
893
  }
538
894
 
895
+ /** Generates a music visualization video from an existing track. */
539
896
  declare class VisualizeMusic {
540
897
  private readonly http;
541
898
  constructor(http: HttpClient);
899
+ /**
900
+ * Create a visualize music task and wait until complete.
901
+ * @param params Visualize music parameters.
902
+ * @param options Per-request and polling overrides.
903
+ * @returns The completed visualize music response.
904
+ */
542
905
  run(params: VisualizeMusicParams, options?: RequestOptions & PollingOptions): Promise<CompletedVisualizeMusicResponse>;
906
+ /**
907
+ * Create a visualize music task; returns immediately with a task id.
908
+ * @param params Visualize music parameters.
909
+ * @param options Per-request overrides.
910
+ * @returns The task creation result.
911
+ */
543
912
  create(params: VisualizeMusicParams, options?: RequestOptions): Promise<TaskCreateResponse>;
913
+ /**
914
+ * Fetch the current status of a visualize music task.
915
+ * @param id The task id.
916
+ * @param options Per-request overrides.
917
+ * @returns The current visualize music task status.
918
+ */
544
919
  get(id: string, options?: RequestOptions): Promise<VisualizeMusicResponse>;
545
920
  }
546
921
 
922
+ /** Produces AI-generated lyrics from a text prompt. */
547
923
  declare class GenerateLyrics {
548
924
  private readonly http;
549
925
  constructor(http: HttpClient);
926
+ /**
927
+ * Create a generate lyrics task and wait until complete.
928
+ * @param params Generate lyrics parameters.
929
+ * @param options Per-request and polling overrides.
930
+ * @returns The completed generate lyrics response.
931
+ */
550
932
  run(params: GenerateLyricsParams, options?: RequestOptions & PollingOptions): Promise<CompletedGenerateLyricsResponse>;
933
+ /**
934
+ * Create a generate lyrics task; returns immediately with a task id.
935
+ * @param params Generate lyrics parameters.
936
+ * @param options Per-request overrides.
937
+ * @returns The task creation result.
938
+ */
551
939
  create(params: GenerateLyricsParams, options?: RequestOptions): Promise<TaskCreateResponse>;
940
+ /**
941
+ * Fetch the current status of a generate lyrics task.
942
+ * @param id The task id.
943
+ * @param options Per-request overrides.
944
+ * @returns The current generate lyrics task status.
945
+ */
552
946
  get(id: string, options?: RequestOptions): Promise<GenerateLyricsResponse>;
553
947
  }
554
948
 
949
+ /** Retrieves word-level timing alignment for a track. Synchronous (run only, no create/get polling). */
555
950
  declare class GetTimestampedLyrics {
556
951
  private readonly http;
557
952
  constructor(http: HttpClient);
953
+ /**
954
+ * Run get timestamped lyrics (synchronous).
955
+ * @param params Get timestamped lyrics parameters.
956
+ * @param options Per-request overrides.
957
+ * @returns The get timestamped lyrics response.
958
+ */
558
959
  run(params: GetTimestampedLyricsParams, options?: RequestOptions): Promise<GetTimestampedLyricsResponse>;
559
960
  }
560
961
 
962
+ /** Re-generates a time range within an existing track with new lyrics and style. */
561
963
  declare class ReplaceSection {
562
964
  private readonly http;
563
965
  constructor(http: HttpClient);
966
+ /**
967
+ * Create a replace section task and wait until complete.
968
+ * @param params Replace section parameters.
969
+ * @param options Per-request and polling overrides.
970
+ * @returns The completed replace section response.
971
+ */
564
972
  run(params: ReplaceSectionParams, options?: RequestOptions & PollingOptions): Promise<CompletedReplaceSectionResponse>;
973
+ /**
974
+ * Create a replace section task; returns immediately with a task id.
975
+ * @param params Replace section parameters.
976
+ * @param options Per-request overrides.
977
+ * @returns The task creation result.
978
+ */
565
979
  create(params: ReplaceSectionParams, options?: RequestOptions): Promise<TaskCreateResponse>;
980
+ /**
981
+ * Fetch the current status of a replace section task.
982
+ * @param id The task id.
983
+ * @param options Per-request overrides.
984
+ * @returns The current replace section task status.
985
+ */
566
986
  get(id: string, options?: RequestOptions): Promise<ReplaceSectionResponse>;
567
987
  }
568
988
 
989
+ /** Blends two audio tracks into a single new composition. */
569
990
  declare class CreateMashup {
570
991
  private readonly http;
571
992
  constructor(http: HttpClient);
993
+ /**
994
+ * Create a create mashup task and wait until complete.
995
+ * @param params Create mashup parameters.
996
+ * @param options Per-request and polling overrides.
997
+ * @returns The completed create mashup response.
998
+ */
572
999
  run(params: CreateMashupParams, options?: RequestOptions & PollingOptions): Promise<CompletedCreateMashupResponse>;
1000
+ /**
1001
+ * Create a create mashup task; returns immediately with a task id.
1002
+ * @param params Create mashup parameters.
1003
+ * @param options Per-request overrides.
1004
+ * @returns The task creation result.
1005
+ */
573
1006
  create(params: CreateMashupParams, options?: RequestOptions): Promise<TaskCreateResponse>;
1007
+ /**
1008
+ * Fetch the current status of a create mashup task.
1009
+ * @param id The task id.
1010
+ * @param options Per-request overrides.
1011
+ * @returns The current create mashup task status.
1012
+ */
574
1013
  get(id: string, options?: RequestOptions): Promise<CreateMashupResponse>;
575
1014
  }
576
1015
 
1016
+ /** Generates sound effects (not music) from a text description with optional looping and BPM control. */
577
1017
  declare class TextToSound {
578
1018
  private readonly http;
579
1019
  constructor(http: HttpClient);
1020
+ /**
1021
+ * Create a text to sound task and wait until complete.
1022
+ * @param params Text to sound parameters.
1023
+ * @param options Per-request and polling overrides.
1024
+ * @returns The completed text to sound response.
1025
+ */
580
1026
  run(params: TextToSoundParams, options?: RequestOptions & PollingOptions): Promise<CompletedTextToSoundResponse>;
1027
+ /**
1028
+ * Create a text to sound task; returns immediately with a task id.
1029
+ * @param params Text to sound parameters.
1030
+ * @param options Per-request overrides.
1031
+ * @returns The task creation result.
1032
+ */
581
1033
  create(params: TextToSoundParams, options?: RequestOptions): Promise<TaskCreateResponse>;
1034
+ /**
1035
+ * Fetch the current status of a text to sound task.
1036
+ * @param id The task id.
1037
+ * @param options Per-request overrides.
1038
+ * @returns The current text to sound task status.
1039
+ */
582
1040
  get(id: string, options?: RequestOptions): Promise<TextToSoundResponse>;
583
1041
  }
584
1042
 
1043
+ /** Creates a reusable style or voice persona from an existing track's vocals. Synchronous (run only). */
585
1044
  declare class GeneratePersona {
586
1045
  private readonly http;
587
1046
  constructor(http: HttpClient);
1047
+ /**
1048
+ * Run generate persona (synchronous).
1049
+ * @param params Generate persona parameters.
1050
+ * @param options Per-request overrides.
1051
+ * @returns The generate persona response.
1052
+ */
588
1053
  run(params: GeneratePersonaParams, options?: RequestOptions): Promise<GeneratePersonaResponse>;
589
1054
  }
590
1055
 
1056
+ /** Generates style/genre tags from a text description for use in style fields. Synchronous (run only). */
591
1057
  declare class BoostStyle {
592
1058
  private readonly http;
593
1059
  constructor(http: HttpClient);
1060
+ /**
1061
+ * Run boost style (synchronous).
1062
+ * @param params Boost style parameters.
1063
+ * @param options Per-request overrides.
1064
+ * @returns The boost style response.
1065
+ */
594
1066
  run(params: BoostStyleParams, options?: RequestOptions): Promise<BoostStyleResponse>;
595
1067
  }
596
1068
 
1069
+ /** Step 1 of voice cloning: extracts a validation phrase from a voice recording for the user to re-record. */
597
1070
  declare class VoiceToValidationPhrase {
598
1071
  private readonly http;
599
1072
  constructor(http: HttpClient);
1073
+ /**
1074
+ * Create a voice to validation phrase task and wait until complete.
1075
+ * @param params Voice to validation phrase parameters.
1076
+ * @param options Per-request and polling overrides.
1077
+ * @returns The completed voice to validation phrase response.
1078
+ */
600
1079
  run(params: VoiceToValidationPhraseParams, options?: RequestOptions & PollingOptions): Promise<CompletedValidationPhraseResponse>;
1080
+ /**
1081
+ * Create a voice to validation phrase task; returns immediately with a task id.
1082
+ * @param params Voice to validation phrase parameters.
1083
+ * @param options Per-request overrides.
1084
+ * @returns The task creation result.
1085
+ */
601
1086
  create(params: VoiceToValidationPhraseParams, options?: RequestOptions): Promise<TaskCreateResponse>;
1087
+ /**
1088
+ * Fetch the current status of a voice to validation phrase task.
1089
+ * @param id The task id.
1090
+ * @param options Per-request overrides.
1091
+ * @returns The current voice to validation phrase task status.
1092
+ */
602
1093
  get(id: string, options?: RequestOptions): Promise<ValidationPhraseResponse>;
603
1094
  }
604
1095
 
1096
+ /** Step 2 (optional) of voice cloning: requests a new, easier validation phrase. */
605
1097
  declare class RegenerateValidationPhrase {
606
1098
  private readonly http;
607
1099
  constructor(http: HttpClient);
1100
+ /**
1101
+ * Create a regenerate validation phrase task and wait until complete.
1102
+ * @param params Regenerate validation phrase parameters.
1103
+ * @param options Per-request and polling overrides.
1104
+ * @returns The completed regenerate validation phrase response.
1105
+ */
608
1106
  run(params: RegenerateValidationPhraseParams, options?: RequestOptions & PollingOptions): Promise<CompletedValidationPhraseResponse>;
1107
+ /**
1108
+ * Create a regenerate validation phrase task; returns immediately with a task id.
1109
+ * @param params Regenerate validation phrase parameters.
1110
+ * @param options Per-request overrides.
1111
+ * @returns The task creation result.
1112
+ */
609
1113
  create(params: RegenerateValidationPhraseParams, options?: RequestOptions): Promise<TaskCreateResponse>;
1114
+ /**
1115
+ * Fetch the current status of a regenerate validation phrase task.
1116
+ * @param id The task id.
1117
+ * @param options Per-request overrides.
1118
+ * @returns The current regenerate validation phrase task status.
1119
+ */
610
1120
  get(id: string, options?: RequestOptions): Promise<ValidationPhraseResponse>;
611
1121
  }
612
1122
 
1123
+ /** Step 3 of voice cloning: trains a custom voice from the user's recording of the validation phrase. */
613
1124
  declare class GenerateVoice {
614
1125
  private readonly http;
615
1126
  constructor(http: HttpClient);
1127
+ /**
1128
+ * Create a generate voice task and wait until complete.
1129
+ * @param params Generate voice parameters.
1130
+ * @param options Per-request and polling overrides.
1131
+ * @returns The completed generate voice response.
1132
+ */
616
1133
  run(params: GenerateVoiceParams, options?: RequestOptions & PollingOptions): Promise<CompletedVoiceGenerationResponse>;
1134
+ /**
1135
+ * Create a generate voice task; returns immediately with a task id.
1136
+ * @param params Generate voice parameters.
1137
+ * @param options Per-request overrides.
1138
+ * @returns The task creation result.
1139
+ */
617
1140
  create(params: GenerateVoiceParams, options?: RequestOptions): Promise<TaskCreateResponse>;
1141
+ /**
1142
+ * Fetch the current status of a generate voice task.
1143
+ * @param id The task id.
1144
+ * @param options Per-request overrides.
1145
+ * @returns The current generate voice task status.
1146
+ */
618
1147
  get(id: string, options?: RequestOptions): Promise<VoiceGenerationResponse>;
619
1148
  }
620
1149
 
1150
+ /** Step 4 of voice cloning: checks whether a custom voice is ready for use. Synchronous (run only). */
621
1151
  declare class CheckVoice {
622
1152
  private readonly http;
623
1153
  constructor(http: HttpClient);
1154
+ /**
1155
+ * Run check voice (synchronous).
1156
+ * @param params Check voice parameters.
1157
+ * @param options Per-request overrides.
1158
+ * @returns The check voice response.
1159
+ */
624
1160
  run(params: CheckVoiceParams, options?: RequestOptions): Promise<CheckVoiceResponse>;
625
1161
  }
626
1162
 
627
1163
  /**
628
- * Suno API client.
1164
+ * Suno music platform client covering song generation, extension, covers, stems,
1165
+ * MIDI, lyrics, mashups, sound effects, visualization, personas, and voice cloning.
629
1166
  *
630
1167
  * @example
631
1168
  * ```typescript
@@ -640,29 +1177,50 @@ declare class CheckVoice {
640
1177
  * });
641
1178
  * ```
642
1179
  */
643
- declare class SunoClient {
1180
+ declare class SunoClient extends BaseClient {
1181
+ /** Generates songs from a text prompt with configurable vocal mode, style, and persona. */
644
1182
  readonly textToMusic: TextToMusic;
1183
+ /** Continues an existing track from a specified timestamp, inheriting or overriding its settings. */
645
1184
  readonly extendMusic: ExtendMusic;
1185
+ /** Creates cover artwork for an existing music task. */
646
1186
  readonly generateArtwork: GenerateArtwork;
1187
+ /** Re-records vocals over an uploaded audio file with a new style or voice. */
647
1188
  readonly coverAudio: CoverAudio;
1189
+ /** Generates and adds an instrumental backing track to uploaded audio. */
648
1190
  readonly addInstrumental: AddInstrumental;
1191
+ /** Generates and adds vocals to an uploaded instrumental track. */
649
1192
  readonly addVocals: AddVocals;
1193
+ /** Splits a track into individual instrument stems (vocals, drums, bass, guitar, etc.). */
650
1194
  readonly separateAudioStems: SeparateAudioStems;
1195
+ /** Extracts per-instrument MIDI note data from a generated track. */
651
1196
  readonly generateMidi: GenerateMidi;
1197
+ /** Converts a generated track to WAV format. */
652
1198
  readonly convertAudio: ConvertAudio;
1199
+ /** Generates a music visualization video from an existing track. */
653
1200
  readonly visualizeMusic: VisualizeMusic;
1201
+ /** Produces AI-generated lyrics from a text prompt. */
654
1202
  readonly generateLyrics: GenerateLyrics;
1203
+ /** Retrieves word-level timing alignment for a track. Synchronous (run only). */
655
1204
  readonly getTimestampedLyrics: GetTimestampedLyrics;
1205
+ /** Re-generates a time range within an existing track with new lyrics and style. */
656
1206
  readonly replaceSection: ReplaceSection;
1207
+ /** Blends two audio tracks into a single new composition. */
657
1208
  readonly createMashup: CreateMashup;
1209
+ /** Generates sound effects (not music) from a text description with optional looping and BPM control. */
658
1210
  readonly textToSound: TextToSound;
1211
+ /** Creates a reusable style or voice persona from a track's vocals. Synchronous (run only). */
659
1212
  readonly generatePersona: GeneratePersona;
1213
+ /** Generates style/genre tags from a text description for use in style fields. Synchronous (run only). */
660
1214
  readonly boostStyle: BoostStyle;
1215
+ /** Step 1 of voice cloning: extracts a validation phrase from a voice recording. */
661
1216
  readonly voiceToValidationPhrase: VoiceToValidationPhrase;
1217
+ /** Step 2 (optional) of voice cloning: requests a new, easier validation phrase. */
662
1218
  readonly regenerateValidationPhrase: RegenerateValidationPhrase;
1219
+ /** Step 3 of voice cloning: trains a custom voice from the user's recording of the validation phrase. */
663
1220
  readonly generateVoice: GenerateVoice;
1221
+ /** Step 4 of voice cloning: checks whether a custom voice is ready for use. Synchronous (run only). */
664
1222
  readonly checkVoice: CheckVoice;
665
1223
  constructor(options?: ClientOptions);
666
1224
  }
667
1225
 
668
- 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 };
1226
+ 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 };