Trabajos asíncronos

Cancelar tarea

Cancela una tarea asíncrona en cola cuando su modelo admite la cancelación

DELETE
/v1/tasks/{id}

Descripción general

Utilice DELETE /v1/tasks/{id} para cancelar una tarea asíncrona que aún no ha comenzado a ejecutarse. Utilice el mismo ID de tarea de la respuesta de creación o la poll_url devuelta.

Tareas admitidas

La cancelación está disponible para tareas de Seedance en cola que utilicen seedance-2.0, seedance-2.0-fast o seedance-2.5 cuando dicha tarea admita la cancelación. Una tarea que ya se esté ejecutando o que se encuentre en un estado terminal no puede cancelarse. Una tarea cancelada no tiene costo. El estado sigue siendo consultable mientras se conserve el registro público de la tarea.

Para cancelar una tarea creada a través del endpoint de Seedance compatible con Volc, consulte Cancelar tarea (compatible con Volc).

Parámetros de ruta

idstringpathobligatorio

El ID de la tarea asíncrona devuelto por la solicitud de creación o incrustado en poll_url.

Respuesta

idstring

Identificador canónico de la tarea asíncrona.

task_idstring

Alias del identificador de la tarea asíncrona.

poll_urlstring

URL de estado para la tarea. Permanece válida después de la cancelación. Realice un poll a GET /v1/tasks/{id} con el id.

statusstring

Estado de la tarea. Una tarea cancelada con éxito se devuelve como failed con cancelled: true para mantener la compatibilidad con los valores de estado existentes.

cancelledboolean

true cuando la tarea fue cancelada antes de su ejecución.

cancellation_statusstring

Marcador de cancelación. El valor es cancelled cuando la cancelación tiene éxito.

errorstring

Motivo de la cancelación o mensaje de error de la tarea.

Comportamiento ante errores

HTTPCódigoSignificado
400missing_task_id, invalid_task_idEl ID de la tarea falta o no es un ID de tarea válido
400unsupported_task_cancelEl tipo de tarea o el modelo no admite la cancelación
403task_not_ownedLa tarea no pertenece al espacio de trabajo de esta API key
404async_task_not_foundLa tarea ha caducado o no está disponible
409task_not_cancellableLa tarea ya se está procesando, ha finalizado o ya no se puede cancelar. current_status indica su estado
503async_task_owner_unavailableLa tarea no se puede leer en este momento. Reintente

Ejemplo

Solicitud

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

Respuesta

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

Autorización

BearerAuth
AuthorizationBearer <token>

Autenticación con API Key. Cree o gestione API keys en Dashboard > API > API Keys.

Ubicación: header

Parámetros de ruta

id*string

El ID de tarea asíncrona devuelto por id / task_id, o incrustado en poll_url

Respuesta

application/json

application/json

application/json

application/json

application/json

application/json

application/json