Start downloading a single variant (returns immediately, poll status via GET)

POST

/api/v1/download/{variantId}

const url = 'http://localhost:8080/api/v1/download/1';
const options = {method: 'POST'};

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

curl --request POST \
  --url http://localhost:8080/api/v1/download/1

Parameters

Path Parameters

variantId

required

integer format: int64

Responses

200

*/*

object

status

string

Allowed values: PENDING IN_PROGRESS COMPLETED FAILED

filepath

string

error

string

totalSegments

integer format: int32

downloadedSegments

integer format: int32

totalBytes

integer format: int64

expectedTotalBytes

integer format: int64