Udio Tasks API 集成与使用指南

1 阅读4分钟

前言

在现代应用开发中,任务调度和状态管理是不可或缺的部分。Udio Tasks API 提供了一种简便的方法来查询由 Udio Audios Generation API 生成的任务状态。本文将详细介绍 Udio Tasks API 的集成方法,帮助开发者快速上手并充分利用该 API 的强大功能。

Udio 及其应用场景

Udio 是 Ace Data Cloud 提供的一项服务,旨在生成音频和视频内容。开发者可以通过 Udio Audios Generation API 创建音频任务,并通过 Udio Tasks API 查询这些任务的执行状态。这对于需要动态生成多媒体内容的应用场景非常有用,例如在线教育、内容创作和社交媒体等。

申请流程

要使用 Udio Tasks API,您需要先在 Udio Audios Generation API 页面申请相关服务。申请成功后,您可以从 Udio Audios Generation API 中复制生成的任务 ID,如下图所示:

接着,前往 Udio Tasks API 页面申请服务,点击“获取”按钮,如下图所示:

申请页面

如果您尚未登录或注册,将会自动跳转至 登录页面,请按照提示完成注册和登录。首次申请用户可获得免费的使用配额。

请求示例

Udio Tasks API 可用于查询 Udio Audios Generation API 的任务结果。以下是如何使用该 API 的示例。假设我们有一个任务 ID:20068983-0cc9-4c6a-aeb6-9c6a3c668be0,接下来演示如何传递该任务 ID。

设置请求头和请求体

请求头包括:

  • accept: 指定响应格式为 JSON,设置为 application/json
  • authorization: 调用 API 的密钥,可在申请后直接选择。

请求体包括:

  • id: 上传的任务 ID。
  • action: 任务的操作方法。

请求示例如下图所示:

代码示例

在页面右侧,可以自动生成多种语言的代码示例,如下图所示:

以下是一个使用 CURL 的示例:

curl -X POST 'https://api.acedata.cloud/udio/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "20068983-0cc9-4c6a-aeb6-9c6a3c668be0",
  "action": "retrieve"
}'

响应示例

成功请求后,API 将返回任务的详细信息。例如:

{
  "_id": "67f67ee9550a4144a5c83f96",
  "id": "20068983-0cc9-4c6a-aeb6-9c6a3c668be0",
  ...
}

返回结果中包含多个字段,request字段为任务发起时的请求信息,response字段为任务完成后返回的响应信息。

批量查询操作

若要查询多个任务 ID 的详细信息,可以使用批量查询。此时,操作需设置为 retrieve_batch

请求体包括:

  • ids: 上传的任务 ID 数组。
  • action: 任务的操作方法。

以下是请求示例:

curl -X POST 'https://api.acedata.cloud/udio/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["e3a575aa-a4bd-49c8-9b12-cde38d5462e0", "20068983-0cc9-4c6a-aeb6-9c6a3c668be0"],
  "action": "retrieve_batch"
}'

响应示例

成功请求后,API 将返回所有批量任务的具体信息。例如:

{
  "items": [
    {
      "_id": "67f67ee9550a4144a5c83f96",
      "id": "20068983-0cc9-4c6a-aeb6-9c6a3c668be0",
      ...
    }
  ],
  "count": 2
}

错误处理

调用 API 时,如果发生错误,API 将返回对应的错误代码和消息。例如:

  • 400 token_mismatched: 错误请求,可能是缺少或无效参数。
  • 401 invalid_token: 未授权,密钥无效或缺失。
  • 429 too_many_requests: 请求过多,超出速率限制。
  • 500 api_error: 服务器内部错误。

错误响应示例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

总结

通过本文,您了解了如何使用 Udio Tasks API 查询单个或批量任务的详细信息。希望本指南能帮助您更好地集成和使用该 API。如有任何问题,请随时联系我们的技术支持团队。


技术标签:#API #Udio #数据处理 #音视频生成 #开发者工具