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

Processo de Solicitação

Para usar a API Fish Audios Generation, primeiro acesse o Painel de Controle da Ace Data Cloud para obter seu Token de API, que deve ser guardado para uso futuro. Se você ainda não estiver logado ou registrado, será redirecionado automaticamente para a página de login, onde será convidado a se registrar e logar. Após a conclusão, você será redirecionado de volta para a página atual. Um Token de API é suficiente para acessar todos os serviços da plataforma, não sendo necessário solicitar um para cada serviço individualmente. A primeira solicitação oferece um crédito gratuito para que você possa experimentar; quando o crédito acabar, você pode recarregar o saldo geral no painel de controle.
📘 Documentação Completa: API Fish Audios Generation →

Exemplo de Solicitação

A API Fish Tasks pode ser usada para consultar os resultados da API Fish Audios Generation. Para saber como usar a API Fish Audios Generation, consulte a documentação API Fish Videos Generation. Usaremos um exemplo de ID de tarefa retornado pelo serviço Fish Audios Generation API. Suponha que temos um ID de tarefa: 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, 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, conforme mostrado na imagem:

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

CURL

Exemplo de Resposta

Após uma solicitação bem-sucedida, a API retornará as informações detalhadas da tarefa aqui. Por exemplo:
O resultado retornado contém vários campos, o campo request é o corpo da solicitação ao iniciar a tarefa, 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 gerado para esta tarefa, usado para identificar exclusivamente esta tarefa gerada.
  • request, informações da solicitação na tarefa consultada.
  • response, informações de retorno na tarefa consultada; quando bem-sucedido, o cost.amount é o crédito efetivamente descontado nesta síntese.
  • created_at, data de criação da tarefa, timestamp Unix (segundos, ponto flutuante).
  • started_at, data de início da execução da tarefa, timestamp Unix (segundos, ponto flutuante).
  • finished_at, data de conclusão da tarefa, timestamp Unix (segundos, ponto flutuante). Este campo não é retornado se a tarefa não estiver concluída.
  • elapsed, tempo gasto na execução da tarefa, em segundos (ponto flutuante, com 3 casas decimais). Este campo não é retornado se a tarefa não estiver concluída.

Operação de Consulta em Lote

Esta operação é para consultar detalhes de várias IDs de tarefas, diferindo do anterior, pois é necessário selecionar a ação como retrieve_batch. Request Body inclui:
  • ids: um array de IDs de tarefas enviadas.
  • 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, conforme 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 em lote. Por exemplo:
返回结果一共有多个字段,其中items是包含了批量任务的具体详情信息,每个任务的具体信息与上文的字段一样,字段信息如下。
  • items,批量任务的所有具体详情信息。它是一个数组,每个数组的元素和上文查询单个任务的返回结果格式是一样的。
  • count,此处批量查询任务的个数。

CURL

Errores

Na chamada da API, se ocorrer um erro, a API retornará o respectivo código de erro e informações. 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

Conclusão

Através deste documento, você já entendeu como usar a API Fish Tasks para consultar detalhes de tarefas 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.