# suno-cover

Music Cover Generation. You can create covers of any accessible music by providing its URL.

## Submit Cover Task (Asynchronous)

### Endpoint

`https://api-us-ca.umodelverse.ai/v1/tasks/submit`

### Input

| Parameter                  | Type   | Required | Description                                                                                                 |
| :------------------------- | :----- | :------- | :---------------------------------------------------------------------------------------------------------- |
| model                      | string | Yes      | Model name. Corresponds to Suno model versions:<br/>`suno-v4`<br/>`suno-v4.5`<br/>`suno-v4.5+`<br/>`suno-v4.5-all`<br/>`suno-v5`<br/>`suno-v5.5` |
| input.prompt               | string | No       | Lyrics. If empty, an instrumental track will be generated. If provided, `tags` and `title` are required.    |
| parameters.upload_url      | string | Yes      | Accessible URL of the music to be covered                                                                   |
| parameters.tags            | string | No       | Music style tags                                                                                            |
| parameters.negative_tags   | string | No       | Tags to avoid                                                                                               |
| parameters.title           | string | No       | Title of the music submission                                                                               |
| parameters.task            | string | Yes      | Task type. Set to `cover`                                                                                   |

### Request Example

⚠️ If you are using Windows, it is recommended to use Postman or other API tools.

```bash
curl --location --globoff 'https://api-us-ca.umodelverse.ai/v1/tasks/submit' \
--header 'Authorization: Bearer <YOUR_API_KEY>' \
--header 'Content-Type: application/json' \
--data '{
  "model": "suno-v4.5+",
  "input": {
    "prompt": "[Verse]\nSample verse lyrics here\n\n[Chorus]\nSample chorus lyrics here"
  },
  "parameters": {
    "upload_url": "https://example.com/song.mp3",
    "negative_tags": "soft, quiet",
    "tags": "rock, punk",
    "title": "Song Title (Cover)",
    "task": "cover"
  }
}'
```

### Output

| Parameter      | Type   | Description                         |
| :------------- | :----- | :---------------------------------- |
| output.task_id | string | Unique identifier of the async task |
| request_id     | string | Unique identifier of the request    |

### Response Example

```json
{
  "output": {
    "task_id": "task_id"
  },
  "request_id": "request_id"
}
```

## Query Task Status

### Endpoint

`https://api-us-ca.umodelverse.ai/v1/tasks/status?task_id=<task_id>`

### Request Example

```shell
curl --location 'https://api-us-ca.umodelverse.ai/v1/tasks/status?task_id=<task_id>' \
--header 'Authorization: <YOUR_API_KEY>'
```

### Output

| Parameter            | Type    | Description                                             |
| :------------------- | :------ | :------------------------------------------------------ |
| output.task_id       | string  | Unique identifier of the async task                     |
| output.task_status   | string  | Task status: `Pending`, `Running`, `Success`, `Failure` |
| output.urls          | array   | List of result URLs (audio files)                       |
| output.submit_time   | integer | Task submission timestamp                               |
| output.finish_time   | integer | Task completion timestamp                               |
| output.error_message | string  | Error message returned when failed                      |
| request_id           | string  | Unique identifier of the request                        |

### Response Example (Success)

```json
{
  "output": {
    "task_id": "task_id",
    "task_status": "Success",
    "urls": ["https://xxxxx/xxxx.mp3"],
    "submit_time": 1756959000,
    "finish_time": 1756959050
  },
  "usage": {
  },
  "request_id": ""
}
```

### Response Example (Failure)

```json
{
  "output": {
    "task_id": "task_id",
    "task_status": "Failure",
    "submit_time": 1756959000,
    "finish_time": 1756959019,
    "error_message": "error_message"
  },
  "request_id": ""
}
```