Passer au contenu principal
La fonction principale de l’API Fish Tasks est de consulter l’état d’exécution d’une tâche en saisissant l’ID de tâche généré par l’API Fish Audios Generation. Ce document présentera en détail les instructions d’intégration de l’API Fish Tasks, afin de vous aider à intégrer facilement et à pleinement exploiter les puissantes fonctionnalités de cette API. Grâce à l’API Fish Tasks, vous pouvez facilement consulter l’état d’exécution des tâches de l’API Fish Audios Generation.

Processus de demande

Pour utiliser l’API Fish Audios Generation, rendez-vous d’abord sur la console Ace Data Cloud pour obtenir votre API Token, à conserver pour une utilisation ultérieure. Si vous n’êtes pas encore connecté ou inscrit, vous serez automatiquement redirigé vers la page de connexion pour vous inviter à vous inscrire et à vous connecter ; une fois terminé, vous reviendrez automatiquement à la page actuelle. Un seul API Token permet d’appeler tous les services de la plateforme, sans avoir besoin de faire une demande distincte pour chaque service. La première demande offre un quota gratuit, permettant une expérience gratuite ; lorsque le quota est insuffisant, vous pouvez recharger le solde général dans la console.
📘 Documentation complète : Fish Audios Generation API →

Exemple de requête

L’API Fish Tasks peut être utilisée pour consulter les résultats de l’API Fish Audios Generation. Pour savoir comment utiliser l’API Fish Audios Generation, veuillez consulter la documentation Fish Videos Generation API 。 Nous prenons comme exemple l’un des ID de tâche retournés par le service API Fish Audios Generation, afin de démontrer comment utiliser cette API. Supposons que nous avons un ID de tâche : 2725a2d3-f87e-4905-9c53-9988d5a7b2f5, nous allons ensuite démontrer comment en transmettant un ID de tâche.

Image d’exemple de tâche

Définir les en-têtes de requête et le corps de requête

Request Headers comprend :
  • accept : spécifie la réception des résultats de réponse au format JSON, remplissez ici application/json.
  • authorization : la clé pour appeler l’API, qui peut être directement sélectionnée dans la liste déroulante après la demande.
Request Body comprend :
  • id : l’ID de tâche téléversé.
  • action : le mode d’opération sur la tâche.
Les paramètres sont définis comme illustré ci-dessous :

Exemple de code

Vous pouvez constater que le code dans différents langages a déjà été généré automatiquement sur le côté droit de la page, comme illustré :

Quelques exemples de code sont les suivants :

CURL

Exemple de réponse

Une fois la requête réussie, l’API retournera les informations détaillées de la tâche ici. Par exemple :
Le résultat retourné comporte plusieurs champs ; le champ request est le request body lors du lancement de la tâche, tandis que le champ response est le response body retourné après l’achèvement de la tâche. La présentation des champs est la suivante.
  • id, l’ID généré pour cette tâche, utilisé pour identifier de manière unique cette tâche de génération.
  • request, les informations de requête dans la tâche de consultation.
  • response, les informations de retour dans la tâche de consultation ; lors de la réussite finale, le cost.amount qu’il contient correspond aux Credits réellement déduits pour cette synthèse.
  • created_at, l’heure de création de la tâche, horodatage Unix (secondes, nombre à virgule flottante).
  • started_at, l’heure de début d’exécution de la tâche, horodatage Unix (secondes, nombre à virgule flottante).
  • finished_at, l’heure d’achèvement de la tâche, horodatage Unix (secondes, nombre à virgule flottante). Ce champ n’est pas retourné lorsque la tâche n’est pas terminée.
  • elapsed, la durée d’exécution de la tâche, en secondes (nombre à virgule flottante, conservant 3 décimales). Ce champ n’est pas retourné lorsque la tâche n’est pas terminée.

Opération de consultation par lots

Il s’agit d’interroger les détails des tâches pour plusieurs ID de tâche ; la différence avec ce qui précède est qu’il est nécessaire de sélectionner retrieve_batch pour action Request Body comprend :
  • ids : le tableau des ID de tâche téléversés.
  • action : le mode d’opération sur la tâche.
Les paramètres sont définis comme illustré ci-dessous :

Exemple de code

Vous pouvez constater que le code dans différents langages a déjà été généré automatiquement sur le côté droit de la page, comme illustré :

Quelques exemples de code sont les suivants :

Exemple de réponse

Une fois la requête réussie, l’API retournera les informations détaillées spécifiques de toutes les tâches par lots cette fois-ci. Par exemple :
Le résultat renvoyé comporte plusieurs champs, parmi lesquels items contient les informations détaillées des tâches par lots, les informations spécifiques de chaque tâche sont les mêmes que les champs ci-dessus, les informations des champs sont les suivantes.
  • items, toutes les informations détaillées spécifiques des tâches par lots. C’est un tableau, chaque élément du tableau a le même format que le résultat renvoyé ci-dessus pour la requête d’une tâche unique.
  • count, le nombre de tâches dans cette requête de tâches par lots.

CURL

Gestion des erreurs

Lors de l’appel de l’API, si une erreur survient, l’API renverra le code d’erreur et les informations correspondants. Par exemple :
  • 400 token_mismatched:Mauvaise requête, possiblement en raison de paramètres manquants ou non valides.
  • 400 api_not_implemented:Mauvaise requête, possiblement en raison de paramètres manquants ou non valides.
  • 401 invalid_token:Non autorisé, jeton d’autorisation non valide ou manquant.
  • 429 too_many_requests:Trop de requêtes, vous avez dépassé la limite de débit.
  • 500 api_error:Erreur interne du serveur, quelque chose s’est mal passé sur le serveur.

Exemple de réponse d’erreur

Conclusion

Grâce à ce document, vous avez appris à utiliser l’API Fish Tasks pour interroger toutes les informations détaillées d’une tâche unique ou de tâches par lots. Nous espérons que ce document pourra vous aider à mieux intégrer et utiliser cette API. Si vous avez des questions, veuillez contacter à tout moment notre équipe d’assistance technique.