TokenLab
Obter chave de API
DocumentaçãoReferência da APIIntegrações

Tarefas assíncronas

Cancelar tarefa

Cancele uma tarefa assíncrona em fila quando o provedor e o modelo oferecem suporte

DELETE
/v1/tasks/{id}

Visão geral

Use DELETE /v1/tasks/{id} para cancelar uma tarefa assíncrona que ainda não começou a executar. Use o mesmo ID de tarefa da resposta create ou o ID incluído em poll_url.

Tarefas suportadas

Tarefas Seedance em fila com seedance-1.5-pro, seedance-2.0, seedance-2.0-fast ou seedance-2.5 podem ser canceladas quando a tarefa oferece suporte. Tarefas em execução ou em estado final não podem ser canceladas. O status permanece consultável enquanto o registro público for mantido.

Parâmetros de caminho

idstringpathobrigatório

ID da tarefa assíncrona retornado pela solicitação create ou incluído em poll_url.

Resposta

idstring

Identificador canônico da tarefa assíncrona.

task_idstring

Alias do identificador da tarefa assíncrona.

poll_urlstring

URL de polling preferida para a tarefa. Ela permanece válida após o cancelamento.

statusstring

Status da tarefa. Uma tarefa cancelada com sucesso é retornada como failed com cancelled: true para compatibilidade com os valores de status existentes.

cancelledboolean

true quando a tarefa foi cancelada antes da execução.

cancellation_statusstring

Marcador de cancelamento. O valor é cancelled quando o cancelamento é bem-sucedido.

errorstring

Motivo do cancelamento ou mensagem de falha da tarefa.

Comportamento de erro

400 unsupported_task_cancel significa que o tipo de tarefa, provedor ou modelo não suporta cancelamento. 409 task_not_cancellable significa que a tarefa já está sendo processada, está terminal ou não pode mais ser cancelada. 403 significa que a API key não pode acessar a tarefa.

Exemplo

Requisição

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"
Response
{
  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "status": "failed",
  "cancelled": true,
  "cancellation_status": "cancelled",
  "error": "Task cancelled before execution"
}
{  "id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "task_id": "ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "poll_url": "/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",  "status": "failed",  "cancelled": true,  "cancellation_status": "cancelled",  "error": "Task cancelled before execution"}

Autorização

BearerAuth
AuthorizationBearer <token>

Autenticação por Chave de API. Crie ou gerencie chaves de API em Dashboard > API > API Keys.

Local: header

Parâmetros de caminho

id*string

O ID da tarefa assíncrona retornado por id / task_id, ou incorporado na poll_url

Resposta

application/json

application/json

application/json

application/json

application/json

application/json

application/json

Obter Status da Tarefa

Anterior

Listar modelos

Próxima