Go to file
blueeon ce0f3159d1
Merge pull request #32 from andy-fang-piccollage/main
Update SunoApi.ts: Hotfix for CLERK_BASE_URL
2024-04-10 13:47:00 +08:00
.github/ISSUE_TEMPLATE Update issue templates 2024-03-29 23:05:08 +08:00
public docs: add banner image 2024-03-28 20:32:47 +08:00
src Update SunoApi.ts: Hotfix for CLERK_BASE_URL 2024-04-10 12:54:19 +08:00
.dockerignore feat: Add support for docker deploy 2024-03-29 15:30:57 +08:00
.env.example feat: add example .env 2024-03-28 20:45:06 +08:00
.eslintrc.json Initial commit from Create Next App 2024-03-27 16:13:15 +08:00
.gitignore feat: Add support for docker deploy 2024-03-29 15:30:57 +08:00
docker-compose.yml feat: Add support for docker deploy 2024-03-29 15:30:57 +08:00
Dockerfile feat: Add support for docker deploy 2024-03-29 15:30:57 +08:00
FUNDING.yml feat: Create FUNDING.yml 2024-04-02 23:05:35 +08:00
icon.png feat: add icon 2024-03-30 00:16:03 +08:00
LICENSE Create LICENSE 2024-03-27 18:17:13 +08:00
next.config.mjs Initial commit from Create Next App 2024-03-27 16:13:15 +08:00
package-lock.json feat: add /v1/chat/completions 2024-04-04 11:12:25 +08:00
package.json feat: Add new API 2024-03-31 16:44:07 +08:00
pnpm-lock.yaml feat: add Analytics 2024-03-29 10:52:07 +08:00
postcss.config.js Initial commit from Create Next App 2024-03-27 16:13:15 +08:00
README_CN.md docs: Add documentation for the new API 2024-04-04 13:38:45 +08:00
README.md docs: Add documentation for the new API 2024-04-04 13:38:45 +08:00
tailwind.config.ts feat: Optimize page style & add Markdown support. 2024-03-28 17:57:24 +08:00
tsconfig.json Initial commit from Create Next App 2024-03-27 16:13:15 +08:00

Suno AI API

Use API to call the music generation AI of Suno.ai and easily integrate it into agents like GPTs.

👉 We update quickly, please star.

English | 简体中文 | Demo | Docs | Deploy with Vercel

gcui-art/suno-api:Open-source SunoAI API - Use API to call the music generation AI of suno.ai. | Product Hunt

suno-api banner

Introduction

Suno.ai v3 is an amazing AI music service. Although the official API is not yet available, we couldn't wait to integrate its capabilities somewhere.

We discovered that some users have similar needs, so we decided to open-source this project, hoping you'll like it.

Demo

We have deployed an example bound to a free Suno account, so it has daily usage limits, but you can see how it runs: suno.gcui.art

Features

  • Perfectly implements the creation API from app.suno.ai
  • Automatically keep the account active.
  • Compatible with the format of OpenAIs /v1/chat/completions API.
  • Supports Custom Mode
  • One-click deployment to Vercel
  • In addition to the standard API, it also adapts to the API Schema of Agent platforms like GPTs and Coze, so you can use it as a tool/plugin/Action for LLMs and integrate it into any AI Agent.
  • Permissive open-source license, allowing you to freely integrate and modify.

Getting Started

  1. Head over to app.suno.ai using your browser.
  2. Open up the browser console: hit F12 or access the Developer Tools.
  3. Navigate to the Network tab.
  4. Give the page a quick refresh.
  5. Identify the request that includes the keyword client?_clerk_js_version.
  6. Click on it and switch over to the Header tab.
  7. Locate the Cookie section, hover your mouse over it, and copy the value of the Cookie.

get cookie

2. Clone and deploy this project

You can choose your preferred deployment method:

Deploy to Vercel

Deploy with Vercel

Run locally

git clone https://github.com/gcui-art/suno-api.git
cd suno-api
npm install

Alternatively, you can use Docker Compose

docker compose build && docker compose up

3. Configure suno-api

  • If deployed to Vercel, please add an environment variable SUNO_COOKIE in the Vercel dashboard, with the value of the cookie obtained in the first step.

  • If youre running this locally, be sure to add the following to your .env file:

SUNO_COOKIE=<your-cookie>

4. Run suno api

  • If youve deployed to Vercel:
    • Please click on Deploy in the Vercel dashboard and wait for the deployment to be successful.
    • Visit the https://<vercel-assigned-domain>/api/get_limit API for testing.
  • If running locally:
    • Run npm run dev.
    • Visit the http://localhost:3000/api/get_limit API for testing.
  • If the following result is returned:
{
  "credits_left": 50,
  "period": "day",
  "monthly_limit": 50,
  "monthly_usage": 50
}

it means the program is running normally.

5. Use Suno API

You can check out the detailed API documentation at : suno.gcui.art/docs

API Reference

Suno API currently mainly implements the following APIs:

- `/api/generate`: Generate music
- `/v1/chat/completions`: Generate music - Call the generate API in a format that works with OpenAIs API.
- `/api/custom_generate`: Generate music (Custom Mode, support setting lyrics, music style, title, etc.)
- `/api/generate_lyrics`: Generate lyrics based on prompt
- `/api/get`: Get music information based on the id. Use “,” to separate multiple ids.
    If no IDs are provided, all music will be returned.
- `/api/get_limit`: Get quota Info

For more detailed documentation, please check out the demo site: suno.gcui.art/docs

API Integration Code Example

Python

import time
import requests

# replace your vercel domain
base_url = 'http://localhost:3000'


def custom_generate_audio(payload):
    url = f"{base_url}/api/custom_generate"
    response = requests.post(url, json=payload, headers={'Content-Type': 'application/json'})
    return response.json()


def generate_audio_by_prompt(payload):
    url = f"{base_url}/api/generate"
    response = requests.post(url, json=payload, headers={'Content-Type': 'application/json'})
    return response.json()


def get_audio_information(audio_ids):
    url = f"{base_url}/api/get?ids={audio_ids}"
    response = requests.get(url)
    return response.json()


def get_quota_information():
    url = f"{base_url}/api/get_limit"
    response = requests.get(url)
    return response.json()


if __name__ == '__main__':
    data = generate_audio_by_prompt({
        "prompt": "A popular heavy metal song about war, sung by a deep-voiced male singer, slowly and melodiously. The lyrics depict the sorrow of people after the war.",
        "make_instrumental": False,
        "wait_audio": False
    })

    ids = f"{data[0]['id']},{data[1]['id']}"
    print(f"ids: {ids}")

    for _ in range(60):
        data = get_audio_information(ids)
        if data[0]["status"] == 'streaming':
            print(f"{data[0]['id']} ==> {data[0]['audio_url']}")
            print(f"{data[1]['id']} ==> {data[1]['audio_url']}")
            break
        # sleep 5s
        time.sleep(5)

Js

const axios = require("axios");

// replace your vercel domain
const baseUrl = "http://localhost:3000";

async function customGenerateAudio(payload) {
  const url = `${baseUrl}/api/custom_generate`;
  const response = await axios.post(url, payload, {
    headers: { "Content-Type": "application/json" },
  });
  return response.data;
}

async function generateAudioByPrompt(payload) {
  const url = `${baseUrl}/api/generate`;
  const response = await axios.post(url, payload, {
    headers: { "Content-Type": "application/json" },
  });
  return response.data;
}

async function getAudioInformation(audioIds) {
  const url = `${baseUrl}/api/get?ids=${audioIds}`;
  const response = await axios.get(url);
  return response.data;
}

async function getQuotaInformation() {
  const url = `${baseUrl}/api/get_limit`;
  const response = await axios.get(url);
  return response.data;
}

async function main() {
  const data = await generateAudioByPrompt({
    prompt:
      "A popular heavy metal song about war, sung by a deep-voiced male singer, slowly and melodiously. The lyrics depict the sorrow of people after the war.",
    make_instrumental: false,
    wait_audio: false,
  });

  const ids = `${data[0].id},${data[1].id}`;
  console.log(`ids: ${ids}`);

  for (let i = 0; i < 60; i++) {
    const data = await getAudioInformation(ids);
    if (data[0].status === "streaming") {
      console.log(`${data[0].id} ==> ${data[0].audio_url}`);
      console.log(`${data[1].id} ==> ${data[1].audio_url}`);
      break;
    }
    // sleep 5s
    await new Promise((resolve) => setTimeout(resolve, 5000));
  }
}

main();

Integration with Custom Agents

You can integrate Suno AI as a tool/plugin/action into your AI agent.

Integration with GPTs

[coming soon...]

Integration with Coze

[coming soon...]

Integration with LangChain

[coming soon...]

Contribution Guidelines

Fork the project and submit a pull request.

License

LGPL-3.0 or later

Contact Us

Statement

suno-api is an unofficial open source project, intended for learning and research purposes only.