World provisioning progress

GET

/api/v1/world/progress

const url = 'http://localhost:11044/api/v1/world/progress';
const options = {method: 'GET', headers: {'X-Embabel-Api-Key': '<X-Embabel-Api-Key>'}};

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

curl --request GET \
  --url http://localhost:11044/api/v1/world/progress \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

What a world being made for the first time is up to. Empty once there is nothing in progress.

Authorizations

apiKeyAuth
basicAuth

Responses

200

The current phase, or an empty object

*/*

How far a world being made for the first time has got. Only provisioning is present when nothing is being made

object

elapsedSeconds

Whole seconds since the build started. Absent when nothing is being provisioned

integer format: int64

phase

The current build phase, lower case. Absent when nothing is being provisioned

string

provisioning

required

True while this user’s world is being built for the first time

boolean

saying

A sentence describing the phase, written to be shown. Absent when nothing is being provisioned

string