Tác vụ bất đồng bộ
Lấy Trạng thái Tác vụ
Truy xuất trạng thái và kết quả của bất kỳ tác vụ async nào bằng cách sử dụng `poll_url` được trả về từ các endpoint create
Tổng quan
Sử dụng endpoint này để polling async hợp nhất trên nhiều loại tác vụ như tạo video, hình ảnh, âm nhạc và 3D.
Nếu phản hồi create bao gồm poll_url, hãy gọi chính xác path đó. Đối với các workflow async mới hơn, poll_url có thể trỏ tới /v1/tasks/{id}.
Tham số Đường dẫn
ID tác vụ được trả về từ yêu cầu create.
Phản hồi
Các trường kết quả, lỗi, thời gian và model được trả về khi tác vụ cung cấp chúng.
Định danh tác vụ.
Bí danh của mã định danh tác vụ bất đồng bộ.
URL polling ưu tiên khi phản hồi tạo tác vụ cung cấp.
Trạng thái tác vụ như pending, processing, completed hoặc failed. Tác vụ đã hủy được biểu diễn là failed với cancelled: true.
true khi một async task đang chờ được hủy trước khi thực thi.
Dấu hiệu hủy. Có giá trị cancelled khi hủy thành công.
Với tác vụ hình ảnh đã hoàn tất, kết quả hình ảnh được tạo sẽ được trả về tại đây. Tác vụ hình ảnh trả về URL trong data[].url.
Giá trị tiến độ tùy chọn. Chỉ được trả về khi có giá trị tiến độ thực; hãy dùng status để xác định khi tác vụ hoàn tất.
URL asset kết quả khi tác vụ hoàn tất và tạo ra một video.
Payload video đơn với url, duration, width, và height khi có.
Nhiều payload video khi tác vụ tạo trả về hơn một kết quả.
Dấu thời gian tạo.
Dấu thời gian cập nhật cuối cùng.
Mô hình được sử dụng cho tác vụ.
Thông báo lỗi khi tác vụ thất bại.
Hành vi lỗi
Tác vụ công khai đã hết hạn hoặc không khả dụng có thể trả 404 async_task_not_found. Nếu không xác nhận được quyền sở hữu cho API key hiện tại, phản hồi là 403 task_not_owned.
{
"error": {
"message": "Task not found or no longer available.",
"type": "invalid_request_error",
"code": "async_task_not_found"
}
}Ví dụ
Yêu cầu
curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-H "Authorization: Bearer sk-your-api-key"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())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());{ "id": "string", "status": "pending", "progress": 0, "created": 0, "updated": 0, "model": "string", "video": { "url": "string", "duration": 0, "width": 0, "height": 0 }, "error": "string", "error_details": { "projection_version": 0, "status": 400, "message": "string", "type": "string", "code": "string", "param": "string", "retryable": true, "upstream": { "source": "string", "code": "string", "message": "string", "param": "string" } }, "task_id": "string", "poll_url": "string", "cancelled": true, "cancellation_status": "cancelled", "billing_transaction_id": "string", "video_url": "string", "videos": [ {} ], "data": [ {} ], "audio_url": "string", "title": "string", "lyrics": "string", "model_url": "string", "glb_url": "string", "fbx_url": "string"}Xác thực
BearerAuth 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 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