Saltar al contenido principal

Descripción general

Usa este endpoint para un sondeo async unificado entre tipos de tareas como generación de video, imagen, música y 3D. Si una respuesta de creación incluye poll_url, llama a esa ruta exacta. Para flujos de trabajo async más recientes, poll_url puede apuntar a /v1/tasks/{id}.

Parámetros de ruta

id
string
requerido
El ID de la tarea devuelto por la solicitud de creación.

Respuesta

id
string
Identificador de la tarea.
task_id
string
Alias del identificador de tarea asíncrona.
poll_url
string
URL de sondeo preferida cuando la respuesta de creación la proporciona.
status
string
Estado de la tarea, como pending, processing, completed o failed. Las tareas canceladas se representan como failed con cancelled: true.
cancelled
boolean
true cuando una tarea asíncrona en cola se canceló antes de la ejecución.
cancellation_status
string
Marcador de cancelación. Presente como cancelled cuando la cancelación se realiza correctamente.
data
array
Para tareas de imagen completadas, los resultados generados se devuelven aquí. Las tareas de imagen devuelven URL en data[].url.
progress
number
Valor de progreso opcional. Solo se devuelve cuando hay un progreso real disponible; usa status para determinar la finalización.
video_url
string
URL del recurso resultante cuando la tarea se completa y produce un video.
error
string
Mensaje de error cuando la tarea falla.

Comportamiento de error

Si la tarea ya no existe, ha expirado o no puede resolverse mediante los detalhes do modelo de tareas async, TokenLab devuelve:
{
  "error": {
    "message": "Task not found or no longer available.",
    "type": "invalid_request_error",
    "code": "async_task_not_found"
  }
}

Ejemplos

curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
Python
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())
JavaScript
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());