Saltar para o conteúdo principal

Documentation Index

Fetch the complete documentation index at: https://docs.xhuoapi.ai/llms.txt

Use this file to discover all available pages before exploring further.

A principal função da API SeeDream Tasks é consultar o status de execução de uma tarefa através do ID da tarefa gerado pela API SeeDream Images Generation. Este documento irá detalhar as instruções de integração da API SeeDream Tasks, ajudando você a integrar facilmente e aproveitar ao máximo o poderoso recurso dessa API. Com a API SeeDream Tasks, você pode consultar facilmente o status de execução das tarefas da API SeeDream Images Generation.

​
Processo de Solicitação

Para usar a API SeeDream Tasks, você precisa primeiro ir à página de solicitação SeeDream Images Generation API para solicitar o serviço correspondente e, em seguida, copiar o ID da tarefa da API SeeDream Images Generation, como mostrado na imagem:

Por fim, acesse a página da API Tasks SeeDream Tasks API para solicitar o serviço correspondente. Após entrar na página, clique no botão “Acquire”, como mostrado na imagem: Página de Solicitação Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, convidando você a se registrar e fazer login. Após o registro e login, você será redirecionado automaticamente de volta para a página atual. Na primeira solicitação, haverá um crédito gratuito disponível, permitindo que você use essa API gratuitamente.

​
Exemplo de Solicitação

A API SeeDream Tasks pode ser usada para consultar os resultados da API SeeDream Images Generation. Para saber como usar a API SeeDream Images Generation, consulte a documentação SeeDream Images Generation API. Usaremos um exemplo de ID de tarefa retornado pelo serviço da API SeeDream Images Generation. Suponha que temos um ID de tarefa: 20068983-0cc9-4c6a-aeb6-9c6a3c668be0, a seguir, demonstraremos como passar um ID de tarefa.

​
Exemplo de Tarefa

​
Configurando Cabeçalhos e Corpo da Solicitação

Request Headers incluem:
  • accept: especifica que a resposta deve ser no formato JSON, preenchido como application/json.
  • authorization: a chave para chamar a API, que pode ser selecionada diretamente após a solicitação.
Request Body inclui:
  • id: o ID da tarefa enviada.
  • action: a forma de operação na tarefa.
Configuração conforme mostrado na imagem abaixo:

​
Exemplo de Código

Pode-se notar que, no lado direito da página, já foram gerados automaticamente códigos em várias linguagens, como mostrado na imagem:

Alguns exemplos de código são os seguintes:

​
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"
}'

​
Exemplo de Resposta

Após uma solicitação bem-sucedida, a API retornará as informações detalhadas da tarefa aqui. Por exemplo: 
{
  "success": true,
  "task_id": "84d1544a-9043-4dde-a98b-e889dacd75f6",
  "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
  "data": [
    {
      "prompt": "um gato siamês branco",
      "size": "2048x2048",
      "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
    }
  ]
}
O resultado retornado contém vários campos, descritos a seguir:
  • success, o status da tarefa de geração de vídeo neste momento.
  • task_id, o ID da tarefa de geração de vídeo neste momento.
  • trace_id, o ID de rastreamento da geração de vídeo neste momento.
  • data, a lista de resultados da tarefa de geração de imagem neste momento.
    • image_url, o link da tarefa de geração de imagem neste momento.
    • prompt, a palavra-chave.
    • size: os pixels da imagem gerada.

​
Operação de Consulta em Lote

Esta operação é para consultar detalhes de várias IDs de tarefa. Diferente do anterior, é necessário selecionar a ação como retrieve_batch. Request Body inclui:
  • ids: um array de IDs de tarefa enviados.
  • action: a forma de operação na tarefa.
Configuração conforme mostrado na imagem abaixo:

​
Exemplo de Código

Alguns exemplos de código são os seguintes:

​
Exemplo de Resposta

Após uma solicitação bem-sucedida, a API retornará as informações detalhadas de todas as tarefas em lote desta vez. Por exemplo: 
{
  "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": "gerar",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "um gato siames branco"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "imagens",
      "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": "um gato siames branco",
            "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": "gerar",
        "model": "doubao-seedream-4-0-250828",
        "prompt": "um gato siames branco"
      },
      "trace_id": "176acf03-7ca7-4fc6-85db-e3724d4f59eb",
      "type": "imagens",
      "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": "um gato siames branco",
            "size": "2048x2048",
            "image_url": "https://platform.cdn.xhuoapi.ai/seedream/6e5f9085-cc4a-4801-b77b-31550129ff19.jpg"
          }
        ]
      }
    }
  ],
  "count": 2
}
返回结果一共有多个字段，其中items是包含了批量任务的具体详情信息，每个任务的具体信息与上文的字段一样，字段信息如下。
  • items，批量任务的所有具体详情信息。它 é um array, cada elemento do array tem o mesmo formato do resultado de consulta de uma única tarefa acima.
  • 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": "recuperar_lote"
}'

​
错误处理

在调用 API 时，如果遇到错误，API 会返回相应的错误代码和信息。例如：
  • 400 token_mismatched：Requisição inválida, possivelmente devido a parâmetros ausentes ou inválidos.
  • 400 api_not_implemented：Requisição inválida, possivelmente devido a parâmetros ausentes ou inválidos.
  • 401 invalid_token：Não autorizado, token de autorização inválido ou ausente.
  • 429 too_many_requests：Muitas requisições, você excedeu o limite de taxa.
  • 500 api_error：Erro interno do servidor, algo deu errado no servidor.

​
错误响应示例

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

​
结论

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