Интеграция и использование API SeeDream Tasks

Основная функция API SeeDream Tasks заключается в том, чтобы запрашивать статус выполнения задачи, используя ID задачи, сгенерированный API SeeDream Images Generation. В этом документе подробно описывается интеграция API SeeDream Tasks, чтобы помочь вам легко интегрировать и в полной мере использовать мощные возможности этого API. С помощью API SeeDream Tasks вы можете легко реализовать запрос статуса выполнения задач API SeeDream Images Generation.

Процесс подачи заявки

Чтобы использовать API SeeDream Tasks, сначала необходимо перейти на страницу заявки SeeDream Images Generation API и подать заявку на соответствующую услугу, затем скопировать ID задачи API SeeDream Images Generation, как показано на рисунке:

Затем перейдите на страницу API Tasks SeeDream Tasks API и подайте заявку на соответствующую услугу, после входа на страницу нажмите кнопку «Acquire», как показано на рисунке: Страница заявки

Если вы еще не вошли в систему или не зарегистрированы, вы будете автоматически перенаправлены на страницу входа, где вас пригласят зарегистрироваться и войти в систему. После регистрации и входа вы будете автоматически возвращены на текущую страницу. При первой подаче заявки предоставляется бесплатный лимит, который позволяет бесплатно использовать этот API.

Пример запроса

API SeeDream Tasks можно использовать для запроса результатов API SeeDream Images Generation. Для получения информации о том, как использовать API SeeDream Images Generation, пожалуйста, обратитесь к документации SeeDream Images Generation API. Мы возьмем один из ID задач, возвращенных сервисом API SeeDream Images Generation, в качестве примера, чтобы продемонстрировать, как использовать этот API. Предположим, у нас есть ID задачи: 20068983-0cc9-4c6a-aeb6-9c6a3c668be0, далее мы покажем, как передать этот ID задачи.

Пример задачи

Установка заголовков запроса и тела запроса

Request Headers включает:

accept: указывает на прием ответа в формате JSON, здесь указывается application/json.
authorization: ключ для вызова API, который можно выбрать из выпадающего списка после подачи заявки.

Request Body включает:

id: загруженный ID задачи.
action: способ выполнения операции над задачей.

Настройка, как показано на рисунке:

Пример кода

Можно заметить, что на правой стороне страницы автоматически сгенерирован код на различных языках, как показано на рисунке:

Некоторые примеры кода:

CURL

curl -X POST 'https://api.xhuoapi.ai/v1/seedream/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "a6e0d456-189b-4c78-9232-2fe72166ab39",
  "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.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
    }
  ]
}

Возвращаемый результат содержит несколько полей, описание которых приведено ниже:

success: статус выполнения задачи по генерации видео.
task_id: ID задачи по генерации видео.
trace_id: ID отслеживания генерации видео.
data: список результатов задачи по генерации изображений.
- image_url: ссылка на задачу по генерации изображения.
- prompt: подсказка.
- size: пиксели сгенерированного изображения.

Пакетный запрос

Это запрос для получения деталей нескольких ID задач, в отличие от предыдущего, здесь необходимо выбрать action как retrieve_batch. Request Body включает:

ids: массив загруженных ID задач.
action: способ выполнения операции над задачей.

Настройка, как показано на рисунке:

Пример кода

Некоторые примеры кода:

Пример ответа

После успешного запроса API вернет конкретную информацию о всех пакетных задачах. Например:

{
  "items": [
    {
      "_id": "69498b9bff2676299c5cb7a6",
      "id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
      "api_id": "86ad30f3-0bc8-4b9b-b019-b9fa5b05672e",
      "application_id": "11e25072-de6d-4bd6-81e7-77ee0055499a",
      "created_at": 1766427547.107,
      "credential_id": "50892af9-597f-426e-a455-bc1739de95b0",
      "request": {
        "action": "generate",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "белый сиамский кот"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "images",
      "user_id": "b60a9491-1eba-4ab8-a93f-12c0fd81dab4",
      "response": {
        "success": true,
        "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
        "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
        "data": [
          {
            "prompt": "белый сиамский кот",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
          }
        ]
      }
    },
    {
      "_id": "69498b9bff2676299c5cb7a6",
      "id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
      "api_id": "86ad30f3-0bc8-4b9b-b019-b9fa5b05672e",
      "application_id": "11e25072-de6d-4bd6-81e7-77ee0055499a",
      "created_at": 1766427547.107,
      "credential_id": "50892af9-597f-426e-a455-bc1739de95b0",
      "request": {
        "action": "generate",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "белый сиамский кот"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "images",
      "user_id": "b60a9491-1eba-4ab8-a93f-12c0fd81dab4",
      "response": {
        "success": true,
        "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
        "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
        "data": [
          {
            "prompt": "белый сиамский кот",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
          }
        ]
      }
    }
  ],
  "count": 2
}

返回结果一共有多个字段，其中items是包含了批量任务的具体详情信息，每个任务的具体信息与上文的字段一样，字段信息如下。

items，批量任务的所有具体详情信息。它是一个数组，每个数组的元素 и上文查询单个任务的返回结果格式是一样的。
count，此处批量查询任务的个数。

CURL

curl -X POST 'https://api.xhuoapi.ai/v1/seedance/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：Неверный запрос, возможно, из-за отсутствия или недействительных параметров.
400 api_not_implemented：Неверный запрос, возможно, из-за отсутствия или недействительных параметров.
401 invalid_token：Неавторизован, недействительный или отсутствующий токен авторизации.
429 too_many_requests：Слишком много запросов, вы превысили лимит частоты.
500 api_error：Внутренняя ошибка сервера, что-то пошло не так на сервере.

错误响应示例

{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "не удалось получить"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}

Заключение

通过本文档，您已经了解了如何使用 SeeDream Tasks API 进行查询单个或批量任务的所有具体详情信息。希望本文档能帮助您更好地对接和使用该 API。如有任何问题，请随时联系我们的技术支持团队。

Documentation Index

​Процесс подачи заявки

​Пример запроса

​Пример задачи

​Установка заголовков запроса и тела запроса

​Пример кода

​CURL

​Пример ответа

​Пакетный запрос

​Пример кода

​Пример ответа

​CURL

​错误处理

​错误响应示例

​Заключение

Процесс подачи заявки

Пример запроса

Пример задачи

Установка заголовков запроса и тела запроса

Пример кода

CURL

Пример ответа

Пакетный запрос

Пример кода

Пример ответа

CURL

错误处理

错误响应示例

Заключение