Sign in

v1

latestOpenAPI 3.0.32026-07-241112213.6 KB

Query Task

Query the status and result of a Photo Avatar task by taskId. Recommended polling interval 3-5 seconds, timeout 5 minutes.

Task status (status): init submitted and waiting; running processing; success succeeded; fail failed (errorMsg contains the reason).

Credits: costCredit is the credits consumed by this task (float). Settled on success, fully refunded on failure.

get/v1/photo_avatar/task/query

Query parameters

taskIdstring required

Task ID (returned by the submit endpoint)

needCloudFrontUrlboolean

Whether to return CloudFront access URLs, default false

Headers

Topview-Uidstring required

User ID

Authorizationstring required

API key, format: Bearer {apiKey}

Response

Query succeeded

codestring

Business status code, 200 on success

messagestring

Message

Example response

{
  "code": "200",
  "message": "Success",
  "result": {
    "taskId": "task-123456",
    "status": "success",
    "costCredit": 5,
    "boardId": "board-12345",
    "boardTaskId": "bt-12345",
    "finishedVideoCoverUrl": "https://example.com/cover.jpg",
    "finishedVideoUrl": "https://example.com/video.mp4",
    "aiAvatar": {
      "aiavatarId": "avatar-001",
      "aiavatarName": "Avatar 01",
      "type": 2
    }
  }
}