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

# 音楽生成

>  - プロンプトから曲を生成：`custom=false` はインスピレーションモード（`prompt` をインスピレーションプロンプトとして使用）、`=true` はカスタムモード（`prompt` を歌詞として使用）。
- 非同期タスク：送信すると `task_id` が返され、`GET /v1/music/tasks/:task_id` をポーリングして結果を取得します 

<Warning>
  `custom` はどのフィールドが有効になるかを決定します：モードと一致しないフィールドは上流で**黙って無視されます**（エラーになりません）。`custom=true`（カスタム）の場合、`prompt`（歌詞）、`title`、`style`、`negative_tags`、`auto_lyrics`、`persona_id`、`style_weight`、`weirdness_constraint`、`audio_weight` が有効です；`custom=false`（インスピレーション）の場合、`prompt` はインスピレーションの説明として使用され、`title`/`style` と上記のカスタムフィールドは無視されます。`vocal_gender` は両方のモードで有効です。
</Warning>

<Note>
  本エンドポイントは独立したルートを使用するため、一部のフィールド名が他のエンドポイントと異なります：`style`（`tags` ではない）。
</Note>

<RequestExample>
  ```bash cURL theme={null}
  curl -X POST https://api.apimart.ai/v1/music/generations \
    -H 'Authorization: Bearer <token>' \
    -H 'Content-Type: application/json' \
    --data '{
      "model": "suno",
      "custom": false,
      "version": "v5",
      "prompt": "深夜の街の lo-fi ピアノに雨音を添えて"
    }'
  ```

  ```bash cURL (カスタムモード) theme={null}
  curl -X POST https://api.apimart.ai/v1/music/generations \
    -H 'Authorization: Bearer <token>' \
    -H 'Content-Type: application/json' \
    --data '{
      "model": "suno",
      "version": "v4.5+",
      "custom": true,
      "instrumental": false,
      "prompt": "[Verse]\nNeon-lit streets on a rainy night",
      "title": "Midnight Drive",
      "style": "synthwave, female vocal, cinematic",
      "negative_tags": "metal, screaming",
      "auto_lyrics": false,
      "vocal_gender": "Female",
      "style_weight": 0.6,
      "weirdness_constraint": 0.3,
      "audio_weight": 0.5
    }'
  ```

  ```python Python theme={null}
  import requests

  url = "https://api.apimart.ai/v1/music/generations"

  payload = {
      "model": "suno",
      "custom": False,
      "version": "v5",
      "prompt": "深夜の街の lo-fi ピアノに雨音を添えて"
  }

  headers = {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
  }

  response = requests.post(url, json=payload, headers=headers)

  print(response.json())
  ```

  ```javascript JavaScript theme={null}
  const url = "https://api.apimart.ai/v1/music/generations";

  const payload = {
    model: "suno",
    custom: false,
    version: "v5",
    prompt: "深夜の街の lo-fi ピアノに雨音を添えて"
  };

  const headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  };

  fetch(url, {
    method: "POST",
    headers: headers,
    body: JSON.stringify(payload)
  })
    .then(response => response.json())
    .then(data => console.log(data))
    .catch(error => console.error('Error:', error));
  ```

  ```go Go theme={null}
  package main

  import (
      "bytes"
      "encoding/json"
      "fmt"
      "io/ioutil"
      "net/http"
  )

  func main() {
      url := "https://api.apimart.ai/v1/music/generations"

      payload := map[string]interface{}{
          "model": "suno",
          "custom": false,
          "version": "v5",
          "prompt": "深夜の街の lo-fi ピアノに雨音を添えて",
      }

      jsonData, _ := json.Marshal(payload)

      req, _ := http.NewRequest("POST", url, bytes.NewBuffer(jsonData))
      req.Header.Set("Authorization", "Bearer <token>")
      req.Header.Set("Content-Type", "application/json")

      client := &http.Client{}
      resp, err := client.Do(req)
      if err != nil {
          panic(err)
      }
      defer resp.Body.Close()

      body, _ := ioutil.ReadAll(resp.Body)
      fmt.Println(string(body))
  }
  ```

  ```java Java theme={null}
  import java.net.http.HttpClient;
  import java.net.http.HttpRequest;
  import java.net.http.HttpResponse;
  import java.net.URI;

  public class Main {
      public static void main(String[] args) throws Exception {
          String url = "https://api.apimart.ai/v1/music/generations";

          String payload = """
          {
            "model": "suno",
            "custom": false,
            "version": "v5",
            "prompt": "深夜の街の lo-fi ピアノに雨音を添えて"
          }
          """;

          HttpClient client = HttpClient.newHttpClient();
          HttpRequest request = HttpRequest.newBuilder()
              .uri(URI.create(url))
              .header("Authorization", "Bearer <token>")
              .header("Content-Type", "application/json")
              .POST(HttpRequest.BodyPublishers.ofString(payload))
              .build();

          HttpResponse<String> response = client.send(request,
              HttpResponse.BodyHandlers.ofString());

          System.out.println(response.body());
      }
  }
  ```

  ```php PHP theme={null}
  <?php

  $url = "https://api.apimart.ai/v1/music/generations";

  $payload = [
      "model" => "suno",
      "custom" => false,
      "version" => "v5",
      "prompt" => "深夜の街の lo-fi ピアノに雨音を添えて"
  ];

  $ch = curl_init($url);
  curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
  curl_setopt($ch, CURLOPT_POST, true);
  curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($payload));
  curl_setopt($ch, CURLOPT_HTTPHEADER, [
      "Authorization: Bearer <token>",
      "Content-Type: application/json"
  ]);

  $response = curl_exec($ch);
  curl_close($ch);

  echo $response;
  ?>
  ```

  ```ruby Ruby theme={null}
  require 'net/http'
  require 'json'
  require 'uri'

  url = URI("https://api.apimart.ai/v1/music/generations")

  payload = {
    model: "suno",
    custom: false,
    version: "v5",
    prompt: "深夜の街の lo-fi ピアノに雨音を添えて"
  }

  http = Net::HTTP.new(url.host, url.port)
  http.use_ssl = true

  request = Net::HTTP::Post.new(url)
  request["Authorization"] = "Bearer <token>"
  request["Content-Type"] = "application/json"
  request.body = payload.to_json

  response = http.request(request)
  puts response.body
  ```

  ```swift Swift theme={null}
  import Foundation

  let url = URL(string: "https://api.apimart.ai/v1/music/generations")!

  let payload: [String: Any] = [
      "model": "suno",
      "custom": false,
      "version": "v5",
      "prompt": "深夜の街の lo-fi ピアノに雨音を添えて"
  ]

  var request = URLRequest(url: url)
  request.httpMethod = "POST"
  request.setValue("Bearer <token>", forHTTPHeaderField: "Authorization")
  request.setValue("application/json", forHTTPHeaderField: "Content-Type")
  request.httpBody = try? JSONSerialization.data(withJSONObject: payload)

  let task = URLSession.shared.dataTask(with: request) { data, response, error in
      if let error = error {
          print("Error: \(error)")
          return
      }

      if let data = data, let responseString = String(data: data, encoding: .utf8) {
          print(responseString)
      }
  }

  task.resume()
  ```

  ```csharp C# theme={null}
  using System;
  using System.Net.Http;
  using System.Text;
  using System.Threading.Tasks;

  class Program
  {
      static async Task Main(string[] args)
      {
          var url = "https://api.apimart.ai/v1/music/generations";

          var payload = @"{
              ""model"": ""suno"",
              ""custom"": false,
              ""version"": ""v5"",
              ""prompt"": ""深夜の街の lo-fi ピアノに雨音を添えて""
          }";

          using var client = new HttpClient();
          client.DefaultRequestHeaders.Add("Authorization", "Bearer <token>");

          var content = new StringContent(payload, Encoding.UTF8, "application/json");
          var response = await client.PostAsync(url, content);
          var result = await response.Content.ReadAsStringAsync();

          Console.WriteLine(result);
      }
  }
  ```

  ```c C theme={null}
  #include <stdio.h>
  #include <curl/curl.h>

  int main(void) {
      CURL *curl;
      CURLcode res;

      curl_global_init(CURL_GLOBAL_DEFAULT);
      curl = curl_easy_init();

      if(curl) {
          const char *url = "https://api.apimart.ai/v1/music/generations";
          const char *payload = "{"
              "\"model\":\"suno\","
              "\"custom\":false,"
              "\"version\":\"v5\","
              "\"prompt\":\"深夜の街の lo-fi ピアノに雨音を添えて\""
          "}";

          struct curl_slist *headers = NULL;
          headers = curl_slist_append(headers, "Authorization: Bearer <token>");
          headers = curl_slist_append(headers, "Content-Type: application/json");

          curl_easy_setopt(curl, CURLOPT_URL, url);
          curl_easy_setopt(curl, CURLOPT_POSTFIELDS, payload);
          curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);

          res = curl_easy_perform(curl);

          if(res != CURLE_OK) {
              fprintf(stderr, "curl_easy_perform() failed: %s\n",
                      curl_easy_strerror(res));
          }

          curl_slist_free_all(headers);
          curl_easy_cleanup(curl);
      }

      curl_global_cleanup();
      return 0;
  }
  ```

  ```objectivec Objective-C theme={null}
  #import <Foundation/Foundation.h>

  int main(int argc, const char * argv[]) {
      @autoreleasepool {
          NSURL *url = [NSURL URLWithString:@"https://api.apimart.ai/v1/music/generations"];

          NSDictionary *payload = @{
              @"model": @"suno",
              @"custom": @NO,
              @"version": @"v5",
              @"prompt": @"深夜の街の lo-fi ピアノに雨音を添えて"
          };

          NSError *error;
          NSData *jsonData = [NSJSONSerialization dataWithJSONObject:payload
                                                            options:0
                                                              error:&error];

          NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
          [request setHTTPMethod:@"POST"];
          [request setValue:@"Bearer <token>" forHTTPHeaderField:@"Authorization"];
          [request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
          [request setHTTPBody:jsonData];

          NSURLSessionDataTask *task = [[NSURLSession sharedSession]
              dataTaskWithRequest:request
              completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                  if (error) {
                      NSLog(@"Error: %@", error);
                      return;
                  }
                  NSString *result = [[NSString alloc] initWithData:data
                                                          encoding:NSUTF8StringEncoding];
                  NSLog(@"%@", result);
              }];

          [task resume];
          [[NSRunLoop mainRunLoop] run];
      }
      return 0;
  }
  ```

  ```ocaml OCaml theme={null}
  (* Requires cohttp and yojson libraries *)
  open Lwt
  open Cohttp
  open Cohttp_lwt_unix

  let url = "https://api.apimart.ai/v1/music/generations"

  let payload = {|{
    "model": "suno",
    "custom": false,
    "version": "v5",
    "prompt": "深夜の街の lo-fi ピアノに雨音を添えて"
  }|}

  let () =
    let headers = Header.init ()
      |> fun h -> Header.add h "Authorization" "Bearer <token>"
      |> fun h -> Header.add h "Content-Type" "application/json"
    in
    let body = Cohttp_lwt.Body.of_string payload in

    let response = Client.post ~headers ~body (Uri.of_string url) >>= fun (resp, body) ->
      body |> Cohttp_lwt.Body.to_string >|= fun body_str ->
      print_endline body_str
    in
    Lwt_main.run response
  ```

  ```dart Dart theme={null}
  import 'dart:convert';
  import 'package:http/http.dart' as http;

  void main() async {
    final url = Uri.parse('https://api.apimart.ai/v1/music/generations');

    final payload = {
      'model': 'suno',
      'custom': false,
      'version': 'v5',
      'prompt': '深夜の街の lo-fi ピアノに雨音を添えて'
    };

    final response = await http.post(
      url,
      headers: {
        'Authorization': 'Bearer <token>',
        'Content-Type': 'application/json',
      },
      body: jsonEncode(payload),
    );

    print(response.body);
  }
  ```

  ```r R theme={null}
  library(httr)
  library(jsonlite)

  url <- "https://api.apimart.ai/v1/music/generations"

  payload <- list(
    model = "suno",
    custom = FALSE,
    version = "v5",
    prompt = "深夜の街の lo-fi ピアノに雨音を添えて"
  )

  response <- POST(
    url,
    add_headers(
      Authorization = "Bearer <token>",
      `Content-Type` = "application/json"
    ),
    body = toJSON(payload, auto_unbox = TRUE),
    encode = "raw"
  )

  cat(content(response, "text"))
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "code": 200,
    "data": [
      {
        "status": "submitted",
        "task_id": "task_01K8SGYNNNVBQTXNR4MM964S7K"
      }
    ]
  }
  ```

  ```json 400 theme={null}
  {
    "error": {
      "code": 400,
      "message": "リクエストパラメータが無効です",
      "type": "invalid_request_error"
    }
  }
  ```

  ```json 401 theme={null}
  {
    "error": {
      "code": 401,
      "message": "認証に失敗しました。API キーを確認してください",
      "type": "authentication_error"
    }
  }
  ```

  ```json 402 theme={null}
  {
    "error": {
      "code": 402,
      "message": "アカウント残高が不足しています。チャージ後に再試行してください",
      "type": "payment_required"
    }
  }
  ```

  ```json 403 theme={null}
  {
    "error": {
      "code": 403,
      "message": "アクセスが禁止されています。このリソースにアクセスする権限がありません",
      "type": "permission_error"
    }
  }
  ```

  ```json 429 theme={null}
  {
    "error": {
      "code": 429,
      "message": "リクエストが頻繁すぎます。しばらくしてから再試行してください",
      "type": "rate_limit_error"
    }
  }
  ```

  ```json 500 theme={null}
  {
    "error": {
      "code": 500,
      "message": "サーバー内部エラーです。しばらくしてから再試行してください",
      "type": "server_error"
    }
  }
  ```

  ```json 502 theme={null}
  {
    "error": {
      "code": 502,
      "message": "ゲートウェイエラーです。サーバーが一時的に利用できません",
      "type": "bad_gateway"
    }
  }
  ```
</ResponseExample>

## Authorizations

<ParamField header="Authorization" type="string" required>
  すべてのエンドポイントは Bearer Token による認証が必要です

  API Key の取得：

  [API Key 管理ページ](https://apimart.ai/keys) にアクセスして API Key を取得してください

  使用時にリクエストヘッダーに追加します：

  ```
  Authorization: Bearer YOUR_API_KEY
  ```
</ParamField>

## Body

<ParamField body="model" type="string" default="suno">
  音声モデル。現在は `suno` を渡します（指定しない場合はデフォルトで `suno`）。
</ParamField>

<ParamField body="custom" type="boolean" default="false">
  `false`=インスピレーションモード；`true`=カスタムモード（`prompt` を歌詞として使用）。デフォルトは `false`。
</ParamField>

<ParamField body="instrumental" type="boolean" default="false">
  `true`=インストゥルメンタルのみ、ボーカルなし。デフォルトは `false`。
</ParamField>

<ParamField body="version" type="string" required>
  生成バージョン：`v3.5` / `v4` / `v4.5` / `v4.5+` / `v4.5-all` / `v5` / `v5.5`。音質と課金に影響します。**両方のモードで必須；指定しない場合は直接 400 が返されます**。
</ParamField>

<ParamField body="prompt" type="string">
  インスピレーションプロンプト / 歌詞。**`custom=false` の場合は必須**（インスピレーションの説明として使用）。`custom=true` の場合：`instrumental=false` なら**必須**（歌詞として使用）；`instrumental=true` なら省略可能。欠落している場合は送信時に直接 400 が返されます（上流を呼び出さず、課金もされません）。
</ParamField>

<ParamField body="title" type="string">
  タイトル（カスタムモード）。**`custom=false`（インスピレーションモード）の場合は無視されます**。
</ParamField>

<ParamField body="style" type="string">
  スタイルタグ（カスタムモード、上流の `tags` に対応）。**`custom=false`（インスピレーションモード）の場合は無視されます**。
</ParamField>

<ParamField body="negative_tags" type="string">
  負のスタイルタグ（避けたいスタイル）。**`custom=true` の場合のみ有効です**。
</ParamField>

<ParamField body="auto_lyrics" type="boolean">
  `true`=入力された歌詞をもとに二次創作します。**`custom=true` の場合のみ有効です**。
</ParamField>

<ParamField body="persona_id" type="string">
  Persona スタイル id。**`custom=true` の場合のみ有効です**。
</ParamField>

<ParamField body="vocal_gender" type="string">
  ボーカルの性別：`Male` / `Female`（`m` / `f` / `male` / `female` も受け付けられ、バックエンドで自動的に正規化されます）。**両方のモードで有効です**。
</ParamField>

<ParamField body="style_weight" type="number">
  スタイルの重み、`0.00`〜`1.00`。**`custom=true` の場合のみ有効です**。
</ParamField>

<ParamField body="weirdness_constraint" type="number">
  創造度、`0.00`〜`1.00`。**`custom=true` の場合のみ有効です**。
</ParamField>

<ParamField body="audio_weight" type="number">
  音声の重み、`0.00`〜`1.00`。**`custom=true` の場合のみ有効です**。
</ParamField>

<Note>
  **結果の取得**：本エンドポイントは非同期タスクです。送信後に `task_id` を取得し、3〜5秒間隔で `GET /v1/music/tasks/{task_id}` をポーリングして、`status` が `completed` または `failed` になるまで待機します（音楽生成は通常30〜120秒；生成中は `status` が `pending` で、`progress` はキュー登録 10 → 準備完了 50 → 完了 100 と進みます）。完了したら `data.result.music[]` から `audio_url` を取得します（ほかに `image_url` / `video_url` / `title` / `duration` などもあります）。失敗した場合は `data.error.message` に原因が示され、事前に差し引かれた枠が自動的に返却されます。
</Note>

## Response

<ResponseField name="code" type="integer">
  レスポンスステータスコード
</ResponseField>

<ResponseField name="data" type="array">
  返却データ配列

  <Expandable title="属性">
    <ResponseField name="status" type="string">
      タスクのステータス

      * `submitted` - 送信済み
    </ResponseField>

    <ResponseField name="task_id" type="string">
      タスクの一意な識別子（`GET /v1/music/tasks/{task_id}` をポーリングして結果を取得するために使用）
    </ResponseField>
  </Expandable>
</ResponseField>