TokenLab

音樂

取得音樂狀態

檢索音樂生成任務的狀態與結果

GET
/v1/tasks/{id}

GET /v1/music/generations/{id} 為相容性端點。現有的整合仍可繼續使用。新的整合請輪詢 GET /v1/tasks/{id};請參閱 取得任務狀態。

呼叫 GET /v1/tasks/{id} 以檢查您的音樂生成任務狀態。

id 與 task_id 指向同一個任務。

已過期或無法取得的公開任務可能會回傳 404 async_task_not_found。若目前的 API key 無法確認任務的所有權,回應將為 403 task_not_owned。

路徑參數 (Path Parameters)

idstringpath必填

音樂生成任務 ID。

回應 (Response)

idstring

任務 ID。

task_idstring

回傳時,與該非同步任務 ID 相同的別名。

poll_urlstring

此任務的狀態 URL。請使用 id 輪詢 GET /v1/tasks/{id}。

statusstring

任務狀態:pending(待處理)、processing(處理中)、completed(已完成)、failed(失敗)或 timeout(逾時)。失敗的任務仍會回傳 HTTP 200。

progressinteger

選填的進度數值。僅在有實際進度數值時回傳;請使用 status 來判斷是否完成。

結果欄位取決於操作類型。音樂可能會回傳 audio_url 和 audio_id;僅歌詞任務會回傳 lyrics;分離任務可能會在 data 中回傳多個檔案。video_url、標題、進度及其他元數據均為選填。請檢查 status 以確認是否完成,並讀取實際回傳的欄位。

audio_idstring

選填的來源音訊 ID,可在支援的後續操作中與此任務 ID 一起使用。

dataarray

選填的輸出陣列,包含帶有 audio_url 或 url 的分離音訊檔案。

audio_urlstring

下載音訊檔案的 URL(完成時)。這是一個 TokenLab 媒體結果連結,有效期為 30 天。

video_urlstring

帶有視覺化效果的影片版本 URL(當模型完成並回傳時)。

image_urlstring

當模型回傳封面圖片時的圖片 URL。

titlestring

生成的歌曲標題。

lyricsstring

生成或提供的歌詞。

errorstring | object

錯誤訊息(失敗時)。

error_detailsobject

任務失敗時的詳細資訊:包含 status、message、type、code、retryable,以及當請求欄位出錯時的 param。

media_retentionobject

結果連結的保存狀態:包含 days 以及 items[](內含 url、kind、status 和 expires_at)。此欄位可能不存在;連結仍可正常運作。請參閱 資料保留。

請求

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://api.tokenlab.sh/v1/media-results/2d7e9a41-8c3b-4b6f-a1e5-7f0c3d9b8e26.mp3?token=…",
  "title": "Night Drive",
  "lyrics": "[Verse 1]\nDriving through the night...",
  "audio_id": "audio_abc123",
  "media_retention": {
    "days": 30,
    "items": [
      {
        "url": "https://api.tokenlab.sh/v1/media-results/2d7e9a41-8c3b-4b6f-a1e5-7f0c3d9b8e26.mp3?token=…",
        "kind": "audio",
        "content_type": "audio/mpeg",
        "status": "saved",
        "expires_at": "2024-02-22T08:54:20.000Z"
      }
    ]
  }
}

授權

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

application/json

application/json

application/json