SeeDream Tasks API 集成与使用指南

在当今数据驱动的时代,Ace Data Cloud 提供了强大的 API 用于各种数据处理任务。其中,SeeDream Tasks API 的主要功能是通过输入由 SeeDream Images Generation API 生成的任务 ID 来查询任务的执行状态。本文将为您提供详细的集成说明,帮助您轻松集成并充分利用 SeeDream Tasks API 的强大功能。

环境准备

在开始之前,您需要:

  1. 注册一个 Ace Data Cloud 账户。
  2. 访问 SeeDream Images Generation API 页面申请相应服务。
  3. 准备好任务 ID,您可以从 SeeDream Images Generation API 的返回结果中获取。

详细步骤

申请过程

首先,访问 SeeDream Images Generation API 页面申请相应服务,并复制生成的任务 ID,如下图所示:

接下来,前往 SeeDream Tasks API 页面申请相应服务。进入页面后,点击“获取”按钮,如下图所示:

申请页面

如果您尚未登录或注册,系统会自动重定向到 登录页面,邀请您进行注册和登录。登录后,您将自动返回到当前页面。

首次申请用户有免费配额,可供您免费使用此 API。

请求示例

SeeDream Tasks API 可用于查询 SeeDream Images Generation API 的结果。有关如何使用 SeeDream Images Generation API 的信息,请参考文档 SeeDream Images Generation API

以下是如何传入任务 ID 的示例:

假设我们拥有任务 ID:20068983-0cc9-4c6a-aeb6-9c6a3c668be0,接下来将展示如何进行 API 调用。

设置请求头和请求体

请求头 包含:

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

请求体 包含:

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

设置示例如下图所示:

代码示例

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

以下是一些代码示例:

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

响应示例

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

{
  "success": true,
  "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
  "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
  "data": [
    {
      "prompt": "a white siamese cat",
      "size": "2048x2048",
      "image_url": "https://platform.cdn.acedata.cloud/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
    }
  ]
}

返回结果中包含多个字段,具体说明如下:

  • success: 表示视频生成任务的状态。
  • task_id: 当前视频生成任务的 ID。
  • trace_id: 当前视频生成的跟踪 ID。
  • data: 当前图像生成任务的结果列表。
  • image_url: 当前图像生成任务的链接。
  • prompt: 提示词。
  • size: 生成图像的像素大小。

批量查询操作

此部分用于查询多个任务 ID 的详细信息。与单个任务查询不同,此时需要选择操作为 retrieve_batch

请求体 包含:

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

设置示例如下图所示:

代码示例

以下是一些代码示例:

CURL
curl -X POST 'https://api.acedata.cloud/seedream/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["84d1544a-9043-4dde-a98b-e889dacd75f6", "84d1544a-9043-4dde-a98b-e889dacd75f6"],
  "action": "retrieve_batch"
}'

错误处理

在调用 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"
}

总结

通过本文,您已经学习了如何使用 SeeDream Tasks API 查询单个或批量任务的具体信息。希望本文能帮助您更好地集成和使用该 API。如果您有任何问题,请随时联系技术支持团队。

技术标签

  • API集成
  • 数据处理
  • Ace Data Cloud
  • Python
  • CURL
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值