Saltar para o conteúdo principal

Visão geral

Use este endpoint para polling assíncrono unificado entre tipos de tarefa como geração de vídeo, imagem, música e 3D. Se uma resposta de criação incluir poll_url, chame esse caminho exato. Para workflows assíncronos mais recentes, poll_url pode apontar para /v1/tasks/{id}.

Parâmetros de caminho

id
string
obrigatório
O ID da tarefa retornado pela requisição de criação.

Resposta

id
string
Identificador da tarefa.
task_id
string
Alias do identificador de tarefa assíncrona.
poll_url
string
URL de polling preferencial quando a resposta de criação a fornece.
status
string
Status da tarefa, como pending, processing, completed ou failed. Tarefas canceladas são representadas como failed com cancelled: true.
cancelled
boolean
true quando uma tarefa assíncrona em fila foi cancelada antes da execução.
cancellation_status
string
Marcador de cancelamento. Presente como cancelled quando o cancelamento é bem-sucedido.
data
array
Para tarefas de imagem concluídas, os resultados de imagem gerados são retornados aqui. Tarefas de imagem retornam URLs em data[].url.
progress
number
Valor de progresso opcional. Retornado apenas quando houver um progresso real disponível; use status para determinar a conclusão.
video_url
string
URL do asset resultante quando a tarefa é concluída e produz um vídeo.
error
string
Mensagem de erro quando a tarefa falha.

Comportamento de erro

Se a tarefa não existir mais, tiver expirado ou não estiver mais disponível no registro público da tarefa, o TokenLab retorna:
{
  "error": {
    "message": "Task not found or no longer available.",
    "type": "invalid_request_error",
    "code": "async_task_not_found"
  }
}

Exemplos

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());