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ụ bất đồng bộ nào: hình ảnh, video, âm nhạc, 3D, Worlds và chuyển đổi âm thanh thành văn bản bất đồng bộ
Tổng quan
Sử dụng GET /v1/tasks/{id} để kiểm tra bất kỳ tác vụ bất đồng bộ nào. Nó phục vụ các tác vụ hình ảnh, video, âm nhạc, 3D, Worlds và chuyển đổi âm thanh thành văn bản bất đồng bộ. Hãy truyền id hoặc task_id từ phản hồi tạo tác vụ.
Các trường kết quả của World, chẳng hạn như world_id và world_marble_url, được ghi lại trong Lấy trạng thái World. Đối với tác vụ World, X-Task-Type là 3d.
Đối với hầu hết các tác vụ, poll_url trong phản hồi tạo tác vụ chính là đường dẫn này. Phản hồi tạo World trả về một poll_url dưới /v1/worlds/generations/{id}; hãy poll /v1/tasks/{id} với id của tác vụ cho cả Worlds.
Các đường dẫn trạng thái theo phương thức, chẳng hạn như /v1/images/{id}, /v1/videos/generations/{id}, /v1/music/generations/{id} và /v1/3d/generations/{id}, là các endpoint tương thích. Chúng vẫn được hỗ trợ cho các tích hợp hiện có.
Việc đọc trạng thái trả về HTTP 200 cho một tác vụ đã thất bại. Hãy đọc status, không phải mã HTTP, để xem kết quả. Các trường kết quả phụ thuộc vào loại tác vụ; xem Lấy trạng thái hình ảnh, Lấy trạng thái video, Lấy trạng thái âm nhạc và Lấy trạng thái 3D. Các liên kết kết quả là các URL phương tiện của TokenLab có hiệu lực trong 30 ngày; xem Lưu trữ dữ liệu.
Tham số đường dẫn
id hoặc task_id được trả về bởi yêu cầu tạo tác vụ.
Phản hồi
Các trường mô tả kết quả, lỗi, dấu thời gian và mô hình được trả về khi có sẵn cho tác vụ.
Định danh tác vụ bất đồng bộ chính tắc.
Bí danh định danh tác vụ bất đồng bộ.
URL trạng thái cho tác vụ này. Poll GET /v1/tasks/{id} với id.
ID giao dịch thanh toán, khi được ghi lại cho tác vụ. Header X-Billing-Transaction-ID mang cùng giá trị này. Đây là định danh thanh toán, không phải định danh tác vụ.
Trạng thái tác vụ: pending, processing, completed, failed hoặc timeout. Dừng polling khi ở trạng thái completed, failed hoặc timeout. Các tác vụ bị hủy được biểu thị là failed với cancelled: true.
true khi một tác vụ bất đồng bộ trong hàng đợi bị hủy trước khi thực thi.
Đánh dấu hủy. Hiển thị là cancelled khi việc hủy thành công.
Đối với các tác vụ hình ảnh đã hoàn thành, kết quả hình ảnh được tạo sẽ trả về tại đây. Các tác vụ hình ảnh trả về URL trong data[].url.
Giá trị tiến độ tùy chọn. Chỉ trả về khi có giá trị tiến độ thực tế; hãy sử dụng status để xác định việc hoàn thành.
URL tài nguyên kết quả khi tác vụ hoàn thành và tạo ra video.
Payload video đơn lẻ với url, duration, width và height khi có sẵn.
Nhiều payload video khi có nhiều hơn một đầu ra.
Lý do tác vụ thất bại: một chuỗi, hoặc một đối tượng với message và, khi biết, type, code, param và retryable.
Chi tiết lỗi khi tác vụ thất bại: status, message, type, code, retryable và param khi một trường yêu cầu bị lỗi.
Trạng thái lưu trữ của các liên kết kết quả: days và items[] với url, kind, status và expires_at. Nó có thể không xuất hiện; các liên kết vẫn hoạt động.
Dấu thời gian tạo khi có sẵn.
Dấu thời gian cập nhật lần cuối khi có sẵn.
Mô hình được sử dụng bởi tác vụ khi có sẵn.
Header phản hồi
Các phản hồi trạng thái thành công bao gồm các header sau:
| Header | Mô tả |
|---|---|
X-Task-ID | ID tác vụ công khai |
X-Task-Type | Nhóm tác vụ, chẳng hạn như image, video, music, 3d hoặc audio |
Cache-Control | no-store. Không lưu bộ nhớ đệm các phản hồi trạng thái |
X-Billing-Transaction-ID | ID giao dịch thanh toán, khi được ghi lại |
X-Task-Cost | Chi phí tác vụ đã quyết toán, khi tác vụ đã quyết toán |
Hành vi lỗi
| HTTP | Mã | Ý nghĩa |
|---|---|---|
400 | missing_task_id, invalid_task_id | ID tác vụ bị thiếu hoặc không phải là ID tác vụ hợp lệ |
403 | task_not_owned | Tác vụ không thuộc về workspace của API key này. Dừng polling tác vụ đó |
404 | async_task_not_found | Tác vụ đã hết hạn hoặc không khả dụng |
503 | async_task_owner_unavailable | Tác vụ không thể đọc được vào lúc này. Hãy thử lại |
{
"error": {
"message": "Task not found or no longer available.",
"type": "invalid_request_error",
"code": "async_task_not_found"
}
}Yêu cầu
curl "https://api.tokenlab.sh/v1/tasks/ldtask_aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" \
-H "Authorization: Bearer sk-your-api-key"{ "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", "last_frame_url": "string", "videos": [ {} ], "data": [ {} ], "audio_url": "string", "title": "string", "lyrics": "string", "model_url": "string", "glb_url": "string", "fbx_url": "string", "media_retention": { "days": 0, "items": [ { "url": "http://example.com", "kind": "image", "content_type": "string", "status": "saving", "expires_at": "2019-08-24T14:15:22Z" } ] }}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
application/json
application/json
application/json