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

# Overview

> Whisul is streamlining the music experience lifecycle. Learn what the API returns and how the endpoints workflow works.

Whisul's AI music generation API turns plain-text prompts into original songs. You describe the music you want — a genre, a mood, or stems — and Whisul generates a full audio track along with cover art, BPM, duration, and tags. Whether you are a content creator looking for background music or an artist prototyping new ideas, Whisul gives you a simple two-endpoint API to generate music programmatically.

<CardGroup cols={2}>
  <Card title="Quickstart" icon="bolt" href="/quickstart">
    Make your first API call and get a generated song URL in under 5 minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/authentication">
    Learn how to obtain your API key and authenticate every request.
  </Card>

  <Card title="Submit a composition" icon="music" href="api-reference/compose">
    POST a text prompt to `/generate `to kick off an async music generation job.
  </Card>

  <Card title="Poll for results" icon="rotate" href="api-reference/get-job">
    GET `/jobs/{job_id}` to check job status and retrieve your audio URL.
  </Card>
</CardGroup>

## How it works

Whisul uses an asynchronous job model. When you submit a prompt, the API immediately returns a `job_id` — generation runs in the background. You then poll the job status endpoint until the job completes, at which point the response includes everything you need to use the track.

### What you get back

A completed job returns the following in the `result` object:

* **`song_url`** — a direct link to the generated audio file
* **`image_url`** — AI-generated cover art for the track
* **`bpm`** — tempo of the generated song
* **`duration`** — length of the track in seconds
* **`title`** — an auto-generated title
* **`tags`** — descriptive tags for the track

### The two endpoints

| Endpoint             | Purpose                                                |
| -------------------- | ------------------------------------------------------ |
| `POST /generate`     | Submit a text prompt and receive a `job_id`            |
| `GET /jobs/{job_id}` | Check job status and retrieve the result when complete |

## Who it's for

Whisul is designed for:

* **Content creators** who need royalty-free background music for videos, podcasts, or social content
* **Artists and producers** who want to quickly prototype musical ideas from text descriptions
* **Developers** building games, apps or platforms that require generated audio

<Note>
  Ready to generate your first track? Head to the [quickstart](/quickstart) to make your first API call.
</Note>
