> ## Documentation Index
> Fetch the complete documentation index at: https://help.soundverse.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# API Documentation

> Welcome to Soundverse API. Our API domain is https://api.soundverse.ai/

<Info>
  🔗 <a href="https://platform.soundverse.ai/" target="_blank" rel="noopener">Soundverse Platform</a>  | 
  <a href="https://www.soundverse.ai/ai-music-generation-api" target="_blank" rel="noopener">API Dashboard</a>
</Info>

***

Soundverse’s **Enterprise API** lets you generate and edit music programmatically covering **AI song generation (with lyrics + vocals)**, instrumental music generation, extend, lyrics, singing, stem separation, and loop/trim, with both **streaming (SSE)** and **synchronous** workflows depending on the endpoint. Soundverse is constantly adding new endpoints to make it an extensive platform with all potential Audio AI usecases.

Base domain (you’ll hit different paths depending on the endpoint/version): [https://api.soundverse.ai](https://api.soundverse.ai)

**Pick your API plan based on expected usage:**

* **Starter** (includes Royalty-Free)
* **Growth** (includes Sample)
* **Scale** (includes Distribution)
* **Pay as you go** (Choose any License)

Soundverse’s API licensing is **plan-based by default** and you can **upgrade licenses via dashboard, or contact the Soundverse Support**.

### How to get an API key

1. Purchase a plan
2. Open [API Dashboard](https://www.soundverse.ai/ai-music-generation-api) (there’s a direct “API Dashboard” link on the docs page).
3. Generate/copy your key, then send it on every request using a Bearer header (example shown in the [v5 Song endpoint docs](https://help.soundverse.ai/enterprise-api/generate/ai-song-gen/ai-song-gen-v5)).

**Example header:**

```http theme={null}
Authorization: Bearer your_api_key_here
Content-Type: application/json
```

### How to choose the right license

Here’s the simplest way to decide (you can also show this as a tooltip / helper in your onboarding):

* **Royalty-Free** (default on many plans): broad commercial use for exported tracks, but *no reselling raw/unmodified exports as libraries/sample packs*.
* **Sample**: you can sample/chop/transform exports inside a new work, but still not resell raw exports “as is.”
* **Distribution**: use when you want explicit rights to release to DSPs/social platforms (Spotify/Apple/YouTube/TikTok, etc.).
* **Sync**: use when pairing music to picture (film/TV/ads/games/apps/campaigns), typically project/campaign scoped.
* **Full Ownership**: exclusive buy-out of the master for that track—best for high-stakes brand work / catalogs / label deals, with broad exploitation rights.

**Plan mapping:**

* Starter includes Royalty-Free
* Growth includes Sample
* Scale includes Distribution, with upgrades optional
* Pay as you go has All Licenses, but costs more

**FAQ links (recommended to surface in your docs)**

* [Enterprise API FAQs (license definitions, FAQs, ownership, sublicensing etc.)](https://help.soundverse.ai/enterprise-api/faqs)

## Available API Endpoints

### AI Song Generation

* [AI Song Gen v5](enterprise-api/generate/ai-song-gen/ai-song-gen-v5)
* [AI Song Gen v4](enterprise-api/generate/ai-song-gen/ai-song-gen-v4)
* [AI Song Gen v1](enterprise-api/generate/ai-song-gen/ai-song-gen-v1)

### AI Music (Instrumental) Generation

* [AI Music Gen v5](enterprise-api/generate/ai-music-gen/ai-music-gen-v5)
* [AI Music Gen v4](enterprise-api/generate/ai-music-gen/ai-music-gen-v4)
* [AI Music Gen v1](enterprise-api/generate/ai-music-gen/ai-music-gen-v1)
* [Text to Music](enterprise-api/generate/ai-music-gen/text-to-music)

### AI Extend

* [Extend Song v5](enterprise-api/generate/ai-music-extend/extend-song-v5)
* [Extend Music v5](enterprise-api/generate/ai-music-extend/extend-music-v5)
* [Extend Music](enterprise-api/generate/ai-music-extend/extend-music)

### AI Lyric Generation

* [Generate Lyrics](enterprise-api/generate/ai-lyric-gen/generate-lyrics)

### AI Singing

* [AI Singing Gen v2](enterprise-api/generate/ai-singing-gen/ai-singing-gen-v2)

### AI Stem Separation

* [Stem Separation](enterprise-api/generate/ai-stem-separation/stem-separation)

### Loop And Trim

* [Loop and Trim](enterprise-api/generate/loop-trim/loop-and-trim)
* [Gen Loop and Trim](enterprise-api/generate/loop-trim/gen_loop_and_trim)

### AI Chat (Beta)

* [Chat Assistant](enterprise-api/assistant/chat)
* [Voice Assistant](enterprise-api/assistant/voice)

### Check Status (`/v5/status`)

* Method: `GET`
* Path: `/v5/status`
* Query parameters:
  * `message_id` *(required)* — string ID of the request to check

**Example Request**

```bash theme={null}
curl -X 'GET' \
  'https://api.soundverse.ai/v5/status?message_id=6a05ae81e622f4000cb9d988' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer your_api_key_here'
```

**Successful Response (200)**

```json theme={null}
{
  "status": "string",
  "message_id": "string",
  "audio_data": {
    "additionalProp1": {}
  },
  "album_art": "string",
  "song_name": "string",
  "progress": 0
}
```

**Errors**

* `401` — Invalid API key format. Use `Bearer <your_api_key>`.
* `422` — Validation Error (invalid or missing `message_id`).