비동기 작업
작업 상태 가져오기
이미지, 비디오, 음악, 3D, Worlds 및 비동기 오디오 전사 등 모든 비동기 작업의 상태와 결과를 검색합니다.
개요
GET /v1/tasks/{id}를 사용하여 모든 비동기 작업을 확인합니다. 이 엔드포인트는 이미지, 비디오, 음악, 3D, Worlds 및 비동기 오디오 전사 작업을 지원합니다. 생성 응답에서 받은 id 또는 task_id를 전달하십시오.
world_id 및 world_marble_url과 같은 World 결과 필드는 월드 상태 가져오기에 문서화되어 있습니다. World 작업의 경우 X-Task-Type은 3d입니다.
대부분의 작업에서 생성 응답의 poll_url은 이 경로와 동일합니다. Worlds 생성 응답은 /v1/worlds/generations/{id} 아래에 poll_url을 반환하지만, Worlds 작업의 경우에도 작업 id를 사용하여 /v1/tasks/{id}를 폴링하십시오.
/v1/images/{id}, /v1/videos/generations/{id}, /v1/music/generations/{id}, /v1/3d/generations/{id}와 같은 모달리티별 상태 경로는 호환성 엔드포인트입니다. 기존 통합을 위해 계속 지원됩니다.
작업이 실패한 경우에도 상태 읽기는 HTTP 200을 반환합니다. 결과를 확인하려면 HTTP 코드가 아닌 status를 읽으십시오. 결과 필드는 작업 유형에 따라 다릅니다. 이미지 상태 가져오기, 비디오 상태 가져오기, 음악 상태 가져오기 및 Get 3D Status를 참조하십시오. 결과 링크는 30일 동안 유효한 TokenLab 미디어 결과 URL입니다. 데이터 보존을 참조하십시오.
경로 매개변수
생성 요청에 의해 반환된 id 또는 task_id입니다.
응답
결과, 오류, 타임스탬프 및 모델을 설명하는 필드는 작업에 대해 사용 가능한 경우 반환됩니다.
표준 비동기 작업 식별자입니다.
비동기 작업 식별자 별칭입니다.
이 작업에 대한 상태 URL입니다. id를 사용하여 GET /v1/tasks/{id}를 폴링하십시오.
작업에 대해 기록된 경우의 결제 트랜잭션 ID입니다. X-Billing-Transaction-ID 헤더는 동일한 값을 전달합니다. 이는 작업 식별자가 아닌 결제 식별자입니다.
작업 상태: pending, processing, completed, failed 또는 timeout입니다. completed, failed 또는 timeout 상태가 되면 폴링을 중단하십시오. 취소된 작업은 cancelled: true와 함께 failed로 표시됩니다.
대기 중인 비동기 작업이 실행 전에 취소된 경우 true입니다.
취소 표시자입니다. 취소가 성공하면 cancelled로 표시됩니다.
완료된 이미지 작업의 경우, 생성된 이미지 결과가 여기에 반환됩니다. 이미지 작업은 data[].url에 URL을 반환합니다.
선택적 진행률 값입니다. 실제 진행률 값을 사용할 수 있는 경우에만 반환됩니다. 완료 여부를 확인하려면 status를 사용하십시오.
작업이 완료되고 비디오가 생성될 때의 결과 에셋 URL입니다.
사용 가능한 경우 url, duration, width 및 height를 포함하는 단일 비디오 페이로드입니다.
둘 이상의 출력을 사용할 수 있는 경우의 다중 비디오 페이로드입니다.
작업이 실패한 이유: 문자열이거나, message를 포함하고 알려진 경우 type, code, param, retryable을 포함하는 객체입니다.
작업 실패 시의 상세 정보: status, message, type, code, retryable 및 요청 필드에 오류가 있는 경우 param을 포함합니다.
결과 링크의 저장 상태: days 및 url, kind, status, expires_at을 포함하는 items[]입니다. 이 필드는 없을 수 있으며, 링크는 여전히 작동합니다.
사용 가능한 경우의 생성 타임스탬프입니다.
사용 가능한 경우의 마지막 업데이트 타임스탬프입니다.
사용 가능한 경우 작업에서 사용된 모델입니다.
응답 헤더
성공적인 상태 응답에는 다음 헤더가 포함됩니다:
| 헤더 | 설명 |
|---|---|
X-Task-ID | 공개 작업 ID |
X-Task-Type | image, video, music, 3d 또는 audio와 같은 작업 제품군 |
Cache-Control | no-store. 상태 응답을 캐시하지 마십시오 |
X-Billing-Transaction-ID | 기록된 경우의 결제 트랜잭션 ID |
X-Task-Cost | 작업이 정산된 경우의 정산된 작업 비용 |
오류 동작
| HTTP | 코드 | 의미 |
|---|---|---|
400 | missing_task_id, invalid_task_id | 작업 ID가 없거나 유효하지 않은 작업 ID입니다 |
403 | task_not_owned | 작업이 이 API 키의 워크스페이스에 속하지 않습니다. 폴링을 중단하십시오 |
404 | async_task_not_found | 작업이 만료되었거나 사용할 수 없습니다 |
503 | async_task_owner_unavailable | 현재 작업을 읽을 수 없습니다. 재시도하십시오 |
{
"error": {
"message": "Task not found or no longer available.",
"type": "invalid_request_error",
"code": "async_task_not_found"
}
}요청
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" } ] }}인증
BearerAuth API 키 인증입니다. Dashboard > API > API Keys에서 API 키를 생성하거나 관리하십시오.
위치: header
경로 매개변수
id / task_id로 반환되거나 poll_url에 포함된 비동기 작업 ID입니다.
응답
application/json
application/json
application/json
application/json
application/json
application/json
application/json