Processo de Solicitação
Para usar a API, você precisa primeiro acessar a página correspondente da API de Geração de Imagens Flux para solicitar o serviço correspondente. Após entrar na página, clique no botão “Adquirir”, conforme mostrado na imagem:
Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, convidando-o a se registrar e fazer login. Após o registro e login, você será redirecionado de volta para a página atual.
Na primeira solicitação, haverá um crédito gratuito disponível, permitindo o uso gratuito da API.
Uso Básico
Primeiro, entenda a forma básica de uso, que é inserir a palavra-chaveprompt, a ação action, e o tamanho da imagem size, para obter o resultado processado. Primeiro, é necessário passar um campo action, cujo valor é generate, e então precisamos inserir a palavra-chave, conforme o conteúdo abaixo:
accept: o formato de resposta desejado, aqui preenchido comoapplication/json, ou seja, formato JSON.authorization: a chave para chamar a API, que pode ser selecionada diretamente após a solicitação.
action: a ação da tarefa de geração de imagem.size: o tamanho do resultado da geração da imagem.count: a quantidade de imagens a serem geradas, o valor padrão é 1, este parâmetro é válido apenas para tarefas de geração de imagens, não é válido para tarefas de edição.prompt: a palavra-chave.model: o modelo de geração, padrãoflux-dev.callback_url: a URL para onde os resultados devem ser retornados.
size tem algumas restrições especiais, que se dividem em dois tipos: proporção largura x altura width x height e proporção de imagem x:y, conforme detalhado abaixo:
| Modelo | Faixa |
|---|---|
| flux-2-flex | Suporta proporção largura x altura x >= 64 deve ser múltiplo de 32 |
| flux-2-pro | Suporta proporção largura x altura x >= 64 deve ser múltiplo de 32 |
| flux-2-max | Suporta proporção largura x altura x >= 64 deve ser múltiplo de 32 |
| flux-pro-1.1 | Suporta proporção largura x altura 256 <= x <= 1440 deve ser múltiplo de 32 |
| flux-dev | Suporta proporção largura x altura 256 <= x <= 1440 deve ser múltiplo de 32 |
| flux-pro-1.1-ultra | Não suporta proporção largura x altura, suporta proporção de imagem |
| flux-kontext-pro | Não suporta proporção largura x altura, suporta proporção de imagem |
| flux-kontext-max | Não suporta proporção largura x altura, suporta proporção de imagem |
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.
data para obter a imagem Flux gerada.
Além disso, se você quiser gerar o código de integração correspondente, pode copiá-lo diretamente, como o código CURL abaixo:
Edição de Tarefas de Imagem
Se você quiser editar uma imagem específica, primeiro o parâmetroimage_url deve conter o link da imagem que precisa ser editada, neste caso, action só suporta edit, e você pode especificar o seguinte conteúdo:
- model: o modelo utilizado para a tarefa de edição de imagem, atualmente suportando
flux-kontext-max,flux-kontext-pro. - image_url: o link da imagem que precisa ser editada.
Callback Assíncrono
由于 Flux Images Generation API gera um tempo relativamente longo, cerca de 1-2 minutos, se a API não responder por um longo período, a solicitação HTTP manterá a conexão, resultando em um consumo adicional de recursos do sistema. Portanto, esta API também oferece suporte a callbacks assíncronos. O fluxo geral é: quando o cliente inicia a solicitação, deve especificar um campocallback_url adicional. Após o cliente fazer a solicitação à API, a API retornará imediatamente um resultado, contendo um campo de informação task_id, que representa o ID da tarefa atual. Quando a tarefa for concluída, o resultado da imagem gerada será enviado para o callback_url especificado pelo cliente, em formato JSON POST, que também incluirá o campo task_id, assim o resultado da tarefa pode ser associado pelo ID.
Abaixo, vamos entender como operar isso através de um exemplo.
Primeiro, o callback Webhook é um serviço que pode receber solicitações HTTP, e os desenvolvedores devem substituí-lo pela URL do servidor HTTP que construíram. Aqui, para facilitar a demonstração, usamos um site de exemplo de Webhook público https://webhook.site/, ao abrir este site, você obterá uma URL de Webhook, como mostrado na imagem:
Copie esta URL, que pode ser usada como Webhook, o exemplo aqui é https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab.
Em seguida, podemos definir o campo callback_url para a URL do Webhook acima, enquanto preenchemos os parâmetros correspondentes, o conteúdo específico é mostrado na imagem:
https://webhook.site/3d32690d-6780-4187-a65c-870061e8c8ab, como mostrado na imagem:
O conteúdo é o seguinte:
task_id, e os outros campos são semelhantes ao mencionado anteriormente, através deste campo é possível realizar a associação da tarefa.
Tratamento de Erros
Ao chamar a API, se ocorrer um erro, a API retornará o código de erro e a mensagem correspondente. 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.