Integração e Uso da API Flux Tasks

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

Processo de Solicitação

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

Por fim, acesse a página da API Flux Tasks Flux Tasks API para solicitar o serviço correspondente. Após acessar a 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 a API gratuitamente.

Exemplo de Solicitação

A API Flux Tasks pode ser usada para consultar os resultados da API Flux Images Generation. Para saber como usar a API Flux Images Generation, consulte o documento Flux Images Generation API. Usaremos um exemplo de ID de tarefa retornado pelo serviço da API Flux Images Generation. Suponha que temos um ID de tarefa: 2db0168c-2373-4367-8d9a-9dc778802e8a, a seguir, demonstraremos como passar um ID de tarefa.

Exemplo de Tarefa

Configurando Cabeçalhos e Corpo da Solicitação

Cabeçalhos da Solicitação 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.

Corpo da Solicitação inclui:

id: o ID da tarefa enviada.
action: a forma de operação sobre a 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/flux/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "id": "2c454ff3-4f8f-47f0-8147-acb29a84d1c2",
  "action": "retrieve"
}'

Python

import requests

url = "https://api.xhuoapi.ai/v1/flux/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "id": "2c454ff3-4f8f-47f0-8147-acb29a84d1c2",
    "action": "retrieve"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Exemplo de Resposta

Após uma solicitação bem-sucedida, a API retornará as informações detalhadas da tarefa de imagem. Por exemplo:

{
  "_id": "677de81d550a4144a5f4cf62",
  "id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
  "api_id": "deefc5d7-7f22-43e9-929e-f2b6afee60b7",
  "application_id": "001c2f84-2a4a-4c4d-ba3f-8a89f43b5be2",
  "created_at": 1736304669.779,
  "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
  "request": {
    "action": "generate",
    "size": "1024x1024",
    "prompt": "a white siamese cat"
  },
  "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
  "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
  "response": {
    "success": true,
    "task_id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
    "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
    "data": [
      {
        "prompt": "a white siamese cat",
        "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/57d9ff7c-5a00-409e-9dcc-90f35b38d16e_0.png",
        "seed": 281520112,
        "timings": {
          "inference": 3.193
        }
      }
    ]
  }
}

O resultado retornado contém vários campos, o campo request é o corpo da solicitação quando a tarefa foi iniciada, enquanto o campo response é o corpo da resposta retornada após a conclusão da tarefa. A descrição dos campos é a seguinte.

id, o ID da tarefa de geração da imagem, usado para identificar exclusivamente esta tarefa de geração de imagem.
request, informações da solicitação na tarefa de imagem.
response, informações da resposta na tarefa de imagem.

Operação de Consulta em Lote

Esta operação é para consultar os detalhes das tarefas de imagem para vários IDs de tarefa. Ao contrário do anterior, é necessário selecionar a ação como retrieve_batch. Corpo da Solicitação inclui:

ids: um array de IDs de tarefa enviados.
action: a forma de operação sobre a 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:

Exemplo de Resposta

Após uma solicitação bem-sucedida, a API retornará as informações detalhadas de todas as tarefas de imagem em lote. Por exemplo:

{
  "items": [
    {
      "_id": "677de81d550a4144a5f4cf62",
      "id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
      "api_id": "deefc5d7-7f22-43e9-929e-f2b6afee60b7",
      "application_id": "001c2f84-2a4a-4c4d-ba3f-8a89f43b5be2",
      "created_at": 1736304669.779,
      "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
      "request": {
        "action": "generate",
        "size": "1024x1024",
        "prompt": "um gato siamês branco"
      },
      "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "2db0168c-2373-4367-8d9a-9dc778802e8a",
        "trace_id": "6624929c-bb80-40c0-81e8-d96af8405d19",
        "data": [
          {
            "prompt": "um gato siamês branco",
            "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/57d9ff7c-5a00-409e-9dcc-90f35b38d16e_0.png",
            "seed": 281520112,
            "timings": {
              "inference": 3.193
            }
          }
        ]
      }
    },
    {
      "_id": "677de950550a4144a5f52963",
      "id": "72bdd69d-290d-4710-a6d4-60c78968865a",
      "api_id": "deefc5d7-7f22-43e9-929e-f2b6afee60b7",
      "application_id": "001c2f84-2a4a-4c4d-ba3f-8a89f43b5be2",
      "created_at": 1736304976.278,
      "credential_id": "b00bddd3-140f-4343-a9a2-affb312b60de",
      "request": {
        "action": "generate",
        "size": "1024x1024",
        "prompt": "um gato siamês branco"
      },
      "trace_id": "1dca4b49-d31d-42e6-83d9-7f0c56f62d31",
      "user_id": "ad7afe47-cea9-4cda-980f-2ad8810e51cf",
      "response": {
        "success": true,
        "task_id": "72bdd69d-290d-4710-a6d4-60c78968865a",
        "trace_id": "1dca4b49-d31d-42e6-83d9-7f0c56f62d31",
        "data": [
          {
            "prompt": "um gato siamês branco",
            "image_url": "https://sf-maas-uat-prod.oss-cn-shanghai.aliyuncs.com/outputs/57b5c7e5-3436-466d-86ed-583ede4a3d7c_0.png",
            "seed": 1437672535,
            "timings": {
              "inference": 3.175
            }
          }
        ]
      }
    }
  ],
  "count": 2
}

CURL

curl -X POST 'https://api.xhuoapi.ai/v1/flux/tasks' \
-H 'accept: application/json' \
-H 'authorization: Bearer {token}' \
-H 'content-type: application/json' \
-d '{
  "ids": ["2db0168c-2373-4367-8d9a-9dc778802e8a","72bdd69d-290d-4710-a6d4-60c78968865a"],
  "action": "retrieve_batch"
}'

Python

import requests

url = "https://api.xhuoapi.ai/v1/flux/tasks"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "ids": ["2db0168c-2373-4367-8d9a-9dc778802e8a","72bdd69d-290d-4710-a6d4-60c78968865a"],
    "action": "retrieve_batch"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

Erro de tratamento

Ao chamar a API, se encontrar um erro, a API retornará o respectivo código de erro e informação. Por exemplo:

400 token_mismatched: Solicitação inválida, possivelmente devido a parâmetros ausentes ou inválidos.
400 api_not_implemented: Solicitaçã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 solicitações, você excedeu o limite de taxa.
500 api_error: Erro interno do servidor, algo deu errado no servidor.

Exemplo de resposta de erro

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

Conclusão

Através deste documento, você já entendeu como usar a API FLux Tasks para consultar informações detalhadas sobre tarefas de imagem individuais ou em lote. Esperamos que este documento possa ajudá-lo a integrar e usar melhor essa API. Se tiver alguma dúvida, entre em contato com nossa equipe de suporte técnico.

Documentation Index

​Processo de Solicitação

​Exemplo de Solicitação

​Exemplo de Tarefa

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

​Exemplo de Código

​CURL

​Python

​Exemplo de Resposta

​Operação de Consulta em Lote

​Exemplo de Código

​Exemplo de Resposta

​CURL

​Python

​Erro de tratamento

​Exemplo de resposta de erro

​Conclusão

Processo de Solicitação

Exemplo de Solicitação

Exemplo de Tarefa

Configurando Cabeçalhos e Corpo da Solicitação

Exemplo de Código

CURL

Python

Exemplo de Resposta

Operação de Consulta em Lote

Exemplo de Código

Exemplo de Resposta

CURL

Python

Erro de tratamento

Exemplo de resposta de erro

Conclusão