音乐

获取音乐状态

获取音乐生成任务的状态和结果

GET
/v1/tasks/{id}

GET /v1/music/generations/{id} 是兼容端点,继续保留,供现有集成使用。新集成请调用 GET /v1/tasks/{id},详见获取任务状态。

使用创建响应中的任务 ID 调用 GET /v1/tasks/{id},查询进度和结果。

id 与 task_id 应视为同一个异步任务标识。

已过期或不可用的公开任务可能返回 404 async_task_not_found。无法确认当前 API 密钥对任务的归属权限时,返回 403 task_not_owned。

路径参数

idstringpath必填

音乐生成任务 ID。

响应

idstring

任务 ID。

task_idstring

同一个异步任务 ID 的别名,仅在返回时存在。

poll_urlstring

任务的状态地址(如有)。用 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 Key。

位置: header

路径参数

id*string

由 id / task_id 返回或嵌入在 poll_url 中的异步任务 ID

响应

application/json

application/json

application/json

application/json

application/json

application/json

application/json