Tarefas assíncronas

Cancelar Tarefa

Cancele uma tarefa assíncrona na fila quando seu modelo suportar cancelamento

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 ser executada. Use o mesmo ID de tarefa da resposta de criação ou da poll_url retornada.

Tarefas Suportadas

O cancelamento está disponível para tarefas Seedance na fila usando seedance-2.0, seedance-2.0-fast ou seedance-2.5 quando essa tarefa suporta cancelamento. Uma tarefa que já esteja em execução ou em um estado terminal não pode ser cancelada. Uma tarefa cancelada não é cobrada. O status permanece consultável enquanto o registro público da tarefa for retido.

Para cancelar uma tarefa criada através do endpoint Seedance compatível com Volc, consulte Cancelar Tarefa (Compatível com Volc).

Parâmetros de Caminho

idstringpathobrigatório

O ID da tarefa assíncrona retornado pela solicitação de criação ou incorporado na poll_url.

Resposta

idstring

Identificador canônico da tarefa assíncrona.

task_idstring

Alias do identificador da tarefa assíncrona.

poll_urlstring

URL de status para a tarefa. Ela permanece válida após o cancelamento. Consulte GET /v1/tasks/{id} com o id.

statusstring

Status da tarefa. Uma tarefa cancelada com sucesso é retornada como failed com cancelled: true para compatibilidade com 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

HTTPCódigoSignificado
400missing_task_id, invalid_task_idO ID da tarefa está ausente ou não é um ID de tarefa válido
400unsupported_task_cancelO tipo de tarefa ou modelo não suporta cancelamento
403task_not_ownedA tarefa não pertence ao workspace desta chave de API
404async_task_not_foundA tarefa expirou ou não está disponível
409task_not_cancellableA tarefa já está sendo processada, finalizada ou não pode mais ser cancelada. current_status fornece seu estado
503async_task_owner_unavailableA tarefa não pode ser lida no momento. Tente novamente

Exemplo

Requisição

cURL
curl -X DELETE "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
  -H "Authorization: Bearer sk-your-api-key"

Resposta

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"
}

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