TokenLab

音樂

獲取音樂狀態

獲取音樂生成任務的狀態與結果

GET
/v1/tasks/{id}

輪詢此端點以檢查音樂生成任務的狀態。

如果建立回應中包含 poll_url,請優先直接呼叫該 URL 輪詢。id 與 task_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

音訊檔案下載連結(完成時)。

video_urlstring

帶有視覺化效果的影片版本連結(完成時)。

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 Key 驗證。請在 Dashboard > API > API Keys 建立或管理 API 金鑰。

位置: header

路徑參數

id*string

由 id / task_id 回傳,或嵌入於 poll_url 中的非同步任務 ID

回應

application/json

application/json

application/json

application/json