suno

Documentation

Overview

Package suno implements engine.Engine for Suno music generation.

Music generation is async: POST /api/generate creates a task, GET /api/feed/{id} polls for completion. Auth: Authorization: Bearer {key}, env SUNO_API_KEY. Uses the suno-api compatible gateway interface.

Index

• Constants
• Variables
• func ConfigSchema() []engine.ConfigField
• func DefaultProvider() engine.Provider
• func ModelInfos() []engine.ModelInfo
• func ModelsByCapability() map[string][]string
• type Config
• type Engine
  • func New(cfg Config) *Engine
  • func (e *Engine) Capabilities() engine.Capability
  • func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)
  • func (e *Engine) Resume(ctx context.Context, remoteID string) (engine.Result, error)

Constants

const (
	ModelChirpV4  = "chirp-v4"
	ModelChirpV35 = "chirp-v3.5"
)

Model constants.

Variables

var (
	ErrMissingBaseURL = errors.New("suno: missing base URL (set Config.BaseURL or SUNO_BASE_URL)")
	ErrMissingPrompt  = errors.New("suno: missing prompt in workflow graph")
)

Functions

func ConfigSchema

func ConfigSchema() []engine.ConfigField

ConfigSchema returns the configuration fields required by the Suno engine.

func DefaultProvider

func DefaultProvider() engine.Provider

DefaultProvider returns preset engine configurations for suno.

func ModelInfos

func ModelInfos() []engine.ModelInfo

ModelInfos returns i18n metadata for all Suno models.

func ModelsByCapability

func ModelsByCapability() map[string][]string

ModelsByCapability returns all known Suno models grouped by capability.

Types

type Config

type Config struct {
	APIKey            string
	BaseURL           string // Required — Suno API gateway URL.
	Model             string
	HTTPClient        *http.Client
	WaitForCompletion bool
	PollInterval      time.Duration
	OnProgress        epoll.OnProgress
}

Config configures the Suno engine.

type Engine

type Engine struct {
	// contains filtered or unexported fields
}

Engine implements engine.Engine for Suno.

func New

func New(cfg Config) *Engine

New creates a Suno engine instance.

func (*Engine) Capabilities

func (e *Engine) Capabilities() engine.Capability

Capabilities implements engine.Describer.

func (*Engine) Execute

func (e *Engine) Execute(ctx context.Context, g workflow.Graph) (engine.Result, error)

Execute generates music via the Suno API gateway.

func (*Engine) Resume

func (e *Engine) Resume(ctx context.Context, remoteID string) (engine.Result, error)

Resume implements engine.Resumer — resumes polling a previously submitted task.