音楽

音楽生成ステータスの取得

音楽生成タスクのステータスと結果を取得します

GET
/v1/tasks/{id}

このエンドポイントをポーリングして、音楽生成タスクのステータスを確認します。

作成レスポンスに poll_url が含まれている場合は、ポーリングにはその URL を優先して使ってください。id と task_id は同じ非同期タスク ID として扱います。

期限切れまたは利用できない公開タスクでは 404 async_task_not_found が返る場合があります。現在の API キーでタスクの所有権を確認できない場合は 403 task_not_owned が返ります。

パスパラメータ

idstringpath必須

音楽生成タスクのID。

レスポンス

idstring

タスクID。

task_idstring

同じ非同期タスク ID の別名。返される場合のみ存在します。

poll_urlstring

作成レスポンスで提供された場合に優先して使うポーリング URL。

statusstring

タスクのステータス: pending、processing、completed、または failed。

progressinteger

任意の進捗値です。実際の進捗値が利用できる場合のみ返されます。完了判定には status を使用してください。

結果のフィールドは操作によって異なります。音楽は audio_url と audio_id、歌詞専用タスクは lyrics、音源分離は data 内に複数ファイルを返す場合があります。video_url、タイトル、進捗などは任意です。完了は status で確認し、実際に返されたフィールドを読んでください。

audio_idstring

後続の対応操作で、このタスク ID とともに使用できる任意の音声 ID。

dataarray

任意の出力配列。分離した音声ファイルの audio_url または url を含みます。

audio_urlstring

オーディオファイルをダウンロードするためのURL(完了時)。

video_urlstring

ビジュアライザー付きビデオバージョンのURL(完了時)。

titlestring

生成された曲のタイトル。

lyricsstring

生成された、または提供された歌詞。

errorstring | object

エラーメッセージ(失敗時)。

リクエスト

curl --fail-with-body "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"

レスポンス

Response (Completed)
{
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "completed",
  "audio_url": "https://cdn.example.com/music/abc123.mp3",
  "title": "Night Drive",
  "lyrics": "[Verse 1]\nDriving through the night...",
  "audio_id": "audio_abc123"
}

認証

BearerAuth
AuthorizationBearer <token>

APIキー認証。Dashboard > API > API KeysでAPIキーを作成または管理します。

場所: header

パスパラメータ

id*string

id / task_id によって返される、または poll_url に埋め込まれた非同期タスクID

レスポンス

application/json

application/json

application/json

application/json