Operations

Image generation - query task result

GET

/v1/tasks/{task_id}

const url = 'https://coder.api.visioncoder.cn/v1/tasks/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://coder.api.visioncoder.cn/v1/tasks/example \
  --header 'Authorization: Bearer <token>'

Authorizations

BearerAuth

Parameters

Path Parameters

task_id

required

string

Task ID returned by POST /v1/images/generations

Responses

200

A successful response.

application/json

GetTaskResp

object

code

required

Status code; 200 means success.

integer

data

required

TaskData

object

required

Task ID

string

status

required

Task status

string

Allowed values: submitted processing completed failed

progress

required

Progress percentage; 100 when completed, otherwise 0.

integer

created

required

Submission timestamp (Unix seconds)

integer format: int64

completed

Completion timestamp (Unix seconds); 0 while unfinished.

integer format: int64

error

Failure reason; present when status is failed.

string

result

TaskImages

Generation result; present when status is completed.

object

images

Image list

Array<object>

TaskImage

object

url

Image URL list

Array<string>

Example

{
  "code": 200,
  "data": {
    "id": "task_01HZY3K8Q2W7X9V4",
    "status": "submitted",
    "progress": 100
  }
}