Module: RunApi::Suno::Types

Defined in:

lib/runapi/suno/types.rb

Overview

Suno type definitions, response models, and enum constants.

Defined Under Namespace

Classes: AddInstrumentalResponse, AddVocalsResponse, AlignedWord, AsyncTaskResponse, Audio, BoostStyleResponse, CheckVoiceResponse, CompletedAddInstrumentalResponse, CompletedAddVocalsResponse, CompletedConvertAudioResponse, CompletedCoverAudioResponse, CompletedCreateMashupResponse, CompletedExtendMusicResponse, CompletedGenerateArtworkResponse, CompletedGenerateLyricsResponse, CompletedGenerateMidiResponse, CompletedReplaceSectionResponse, CompletedSeparateAudioStemsResponse, CompletedTextToMusicResponse, CompletedTextToSoundResponse, CompletedValidationPhraseResponse, CompletedVisualizeMusicResponse, CompletedVoiceGenerationResponse, ConvertAudioResponse, Cover, CoverAudioResponse, CreateMashupResponse, ExtendMusicResponse, GenerateArtworkResponse, GenerateLyricsResponse, GenerateMidiResponse, GeneratePersonaResponse, GetTimestampedLyricsResponse, Lyric, MidiInstrument, MidiNote, Persona, ReplaceSectionResponse, SeparateAudioStemsResponse, SeparatedAudio, SoundAudio, TextToMusicResponse, TextToSoundResponse, ValidationPhraseResponse, VisualizeMusicResponse, VoiceGenerationResponse

Constant Summary

MODELS =

Suno music generation engine versions. V5.5 has highest quality; V4 is the earliest available.

%w[suno-v5.5 suno-v5 suno-v4.5-plus suno-v4.5-all suno-v4.5 suno-v4].freeze

SOUND_MODELS =

Model versions that support sound effect generation (subset of MODELS).

%w[suno-v5 suno-v5.5].freeze

SOUND_KEYS =

Musical keys (major and minor) for sound effect generation.

%w[
  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
].freeze

VOCAL_GENDERS =

%w[female male].freeze

PERSONA_TYPES =

“style” applies genre/mood without changing voice; “voice” applies cloned voice characteristics.

%w[style voice].freeze

PARAMETER_MODES =

“source” inherits settings from the original track; “custom” requires explicit values.

%w[source custom].freeze

VOCAL_MODES =

auto_lyrics: generates from prompt; exact_lyrics: sings literal lyrics; instrumental: no vocals.

%w[auto_lyrics exact_lyrics instrumental].freeze

SEPARATE_AUDIO_STEMS_TYPES =

separate_vocal: isolates vocals+instrumental; split_stem: splits into all individual instruments.

%w[separate_vocal split_stem].freeze

VALIDATION_PHRASE_LANGUAGES =

Language for the voice-cloning validation phrase the user must read back.

%w[en zh es fr pt de ja ko hi ru].freeze

SINGER_SKILL_LEVELS =

Singing ability of the voice being cloned; calibrates model expectations.

%w[beginner intermediate advanced professional].freeze