List worlds

GET

/api/v1/worlds

const url = 'http://localhost:11044/api/v1/worlds';
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/worlds \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Lists all worlds for the current user.

Authorizations

apiKeyAuth
basicAuth

Responses

200

World listing

*/*

Every world this user has, and which one they are in

object

current

required

The world the user is currently in, by name

string

worlds

required

Every world discovered on disk for this user, sorted by name

Array<object>

One of a user’s worlds, as the listing describes it

object

active

required

Whether this is the world the user is currently in

boolean

name

required

The world’s name, which is what the other endpoints take in the path

string

path

required

Where the world lives on the appliance’s disk

string