TokenLab

Tác vụ bất đồng bộ

Hủy tác vụ

Hủy một tác vụ bất đồng bộ đang chờ xử lý khi mô hình hỗ trợ tính năng hủy

DELETE
/v1/tasks/{id}

Tổng quan

Sử dụng DELETE /v1/tasks/{id} để hủy một tác vụ bất đồng bộ chưa bắt đầu chạy. Sử dụng cùng ID tác vụ từ phản hồi tạo tác vụ hoặc poll_url được trả về.

Các tác vụ được hỗ trợ

Tính năng hủy khả dụng cho các tác vụ Seedance đang chờ xử lý sử dụng seedance-2.0, seedance-2.5-fast hoặc seedance-2.5 khi tác vụ đó hỗ trợ hủy. Một tác vụ đã đang chạy hoặc ở trạng thái kết thúc không thể bị hủy. Tác vụ bị hủy sẽ không bị tính phí. Trạng thái vẫn có thể truy vấn được trong khi bản ghi tác vụ công khai vẫn được lưu giữ.

Để hủy một tác vụ được tạo thông qua endpoint Seedance tương thích với Volc, xem Hủy tác vụ (Tương thích Volc).

Tham số đường dẫn

idstringpathbắt buộc

ID tác vụ bất đồng bộ được trả về bởi yêu cầu tạo hoặc được nhúng trong poll_url.

Phản hồi

idstring

Định danh tác vụ bất đồng bộ chính thức.

task_idstring

Bí danh định danh tác vụ bất đồng bộ.

poll_urlstring

URL trạng thái cho tác vụ. URL này vẫn hợp lệ sau khi hủy. Thực hiện poll GET /v1/tasks/{id} với id.

statusstring

Trạng thái tác vụ. Một tác vụ đã hủy thành công được trả về là failed với cancelled: true để tương thích với các giá trị trạng thái hiện có.

cancelledboolean

true khi tác vụ đã bị hủy trước khi thực thi.

cancellation_statusstring

Đánh dấu hủy. Giá trị là cancelled khi việc hủy thành công.

errorstring

Lý do hủy hoặc thông báo lỗi tác vụ.

Hành vi lỗi

HTTPMãÝ nghĩa
400missing_task_id, invalid_task_idID tác vụ bị thiếu hoặc không phải là ID tác vụ hợp lệ
400unsupported_task_cancelLoại tác vụ hoặc mô hình không hỗ trợ hủy
403task_not_ownedTác vụ không thuộc về workspace của API key này
404async_task_not_foundTác vụ đã hết hạn hoặc không khả dụng
409task_not_cancellableTác vụ đang xử lý, đã hoàn thành hoặc không còn khả năng hủy. current_status cung cấp trạng thái hiện tại của nó
503async_task_owner_unavailableKhông thể đọc tác vụ vào lúc này. Vui lòng thử lại

Ví dụ

Yêu cầu

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

Phản hồi

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

Xác thực

BearerAuth
AuthorizationBearer <token>

Xác thực bằng Khóa API. Tạo hoặc quản lý khóa API trong Dashboard > API > API Keys.

Vị trí: header

Tham số đường dẫn

id*string

ID tác vụ async được trả về bởi id / task_id, hoặc được nhúng trong poll_url

Phản hồi

application/json

application/json

application/json

application/json

application/json

application/json

application/json