Tâches asynchrones
Obtenir le statut d'une tâche
Récupérez le statut et le résultat de n'importe quelle tâche async en utilisant le `poll_url` renvoyé par les endpoints de création
Vue d’ensemble
Utilisez cet endpoint pour un polling async unifié entre différents types de tâches tels que la génération de vidéo, d’image, de musique et de 3D.
Si une réponse de création inclut poll_url, appelez ce chemin exact. Pour les workflows async plus récents, poll_url peut pointer vers /v1/tasks/{id}.
Paramètres de chemin
L’ID de tâche renvoyé par la requête de création.
Réponse
Les champs de résultat, d’erreur, d’horodatage et de modèle sont renvoyés lorsqu’ils sont disponibles pour la tâche.
Identifiant de la tâche.
Alias de l’identifiant de tâche asynchrone.
URL de polling à privilégier lorsque la réponse de création la fournit.
Statut de la tâche, par exemple pending, processing, completed ou failed. Les tâches annulées sont représentées comme failed avec cancelled: true.
true lorsqu’une tâche asynchrone en file d’attente a été annulée avant l’exécution.
Marqueur d’annulation. Présent avec la valeur cancelled lorsque l’annulation réussit.
Pour les tâches d’image terminées, les résultats générés sont renvoyés ici. Les tâches d’image renvoient des URL dans data[].url.
Valeur de progression facultative. Renvoyée uniquement lorsqu’une progression réelle est disponible ; utilisez status pour déterminer la fin de la tâche.
URL de l’asset de résultat lorsque la tâche est terminée et produit une vidéo.
Charge utile d'une seule vidéo avec url, duration, width et height lorsque disponible.
Plusieurs charges utiles vidéo lorsque la tâche de génération renvoie plus d'une sortie.
Horodatage de création.
Horodatage de la dernière mise à jour.
Modèle utilisé pour la tâche.
Message d’erreur lorsque la tâche échoue.
Comportement d’erreur
Une tâche publique expirée ou indisponible peut renvoyer 404 async_task_not_found. Si son appartenance à la clé API actuelle ne peut pas être établie, la réponse est 403 task_not_owned.
{
"error": {
"message": "Task not found or no longer available.",
"type": "invalid_request_error",
"code": "async_task_not_found"
}
}Exemples
Requête
curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-H "Authorization: Bearer sk-your-api-key"import requests
poll_url = "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
response = requests.get(
f"https://api.tokenlab.sh{poll_url}",
headers={"Authorization": "Bearer sk-your-api-key"},
)
print(response.json())const pollUrl = '/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa';
const response = await fetch(`https://api.tokenlab.sh${pollUrl}`, {
headers: { Authorization: 'Bearer sk-your-api-key' },
});
console.log(await response.json());{ "id": "string", "status": "pending", "progress": 0, "created": 0, "updated": 0, "model": "string", "video": { "url": "string", "duration": 0, "width": 0, "height": 0 }, "error": "string", "error_details": { "projection_version": 0, "status": 400, "message": "string", "type": "string", "code": "string", "param": "string", "retryable": true, "upstream": { "source": "string", "code": "string", "message": "string", "param": "string" } }, "task_id": "string", "poll_url": "string", "cancelled": true, "cancellation_status": "cancelled", "billing_transaction_id": "string", "video_url": "string", "videos": [ {} ], "data": [ {} ], "audio_url": "string", "title": "string", "lyrics": "string", "model_url": "string", "glb_url": "string", "fbx_url": "string"}Autorisation
BearerAuth Authentification par clé API. Créez ou gérez vos clés API dans Dashboard > API > API Keys.
Emplacement: header
Paramètres de chemin
L'ID de tâche asynchrone renvoyé par id / task_id, ou intégré dans poll_url
Réponse
application/json
application/json
application/json
application/json