Factory reset world

POST

/api/v1/worlds/{name}/reset

const url = 'http://localhost:11044/api/v1/worlds/example/reset';
const options = {method: 'POST', 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 POST \
  --url http://localhost:11044/api/v1/worlds/example/reset \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Wipes the world’s config/ directory and re-clones it from the default template. The data/ directory is left untouched — documents, vibe-coded apps, tasks, learnings, generated artifacts and entered secrets are preserved. To wipe everything including data, delete the world instead.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

name

required

string

Name of one of the current user’s worlds, as listed by GET /worlds; its config/ is replaced from the bootstrap template and data/ kept. The active world is rebuilt straight away; a name with no directory answers 404

Responses

200

World config reset to defaults; data preserved

*/*

A world’s config was reset to the template. Its data/ was left alone, which the warning says out loud

object

name

required

The world that was reset

string

status

required

Always reset

string

Example

reset

warning

required

That the config went back to defaults and the data directory was preserved — said in the body because a caller who reads only the status code would not know the difference between this and a delete

string

404

World not found

*/*

A refusal from the world management surface. Carries only the reason, with no status word — the status code is the only other fact and the body does not repeat it

object

error

required

Why the operation was refused, written to be shown. Names the world where the refusal is about a particular one

string