Skip to content

World overview

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

Returns a summary of the world including counts and names of skills, APIs, actions, types, and MCP servers.

World summary

Media type*/*

A summary of everything a world has loaded

object
actions
required

The compiled actions and goals

Array<object>

One named thing in a world — a skill, an API, an action or a tool — and what it is for

object
description

What it is for, as it describes itself. Empty, not null, for a tool with no description

string
name
required

Its name, unique within its list

string
apis
required

The learned APIs

Array<object>

One named thing in a world — a skill, an API, an action or a tool — and what it is for

object
description

What it is for, as it describes itself. Empty, not null, for a tool with no description

string
name
required

Its name, unique within its list

string
documents
required

The world’s documents

Array<object>

One world document, and who last changed it

object
lastModifiedBy
required

Who or what last wrote it

string
Allowed values: USER ASSISTANT EXTERNAL UNKNOWN
name
required

The document’s name

string
mcpServers
required

The MCP servers the world itself configures

Array<object>

One MCP server a world configures, and how many tools it offers

object
description
required

What the server is for; empty when it declares nothing

string
name
required

The server’s name

string
toolCount
required

How many tools it offers

integer format: int32
path
required

The world’s directory on the server

string
realms
required

The installed realms

Array<object>

One installed realm, as its realm.yml describes it

object
author
required

Who wrote it; empty when it declares nobody

string
description
required

What the realm does; empty when it declares nothing

string
name
required

The realm’s name

string
tags
required

The realm’s listing tags

Array<string>
url

Where the realm lives, or null when its listing names nowhere

string
version
required

The realm’s version

string
skills
required

The loaded skills

Array<object>

One named thing in a world — a skill, an API, an action or a tool — and what it is for

object
description

What it is for, as it describes itself. Empty, not null, for a tool with no description

string
name
required

Its name, unique within its list

string
types
required

The world’s own types

Array<object>

One of a world’s own types, with the names of its properties

object
description

What the type represents

string
name
required

The type’s name

string
properties
required

The names of its properties, inherited ones included

Array<string>
webhooks
required

The webhooks the world registers

Array<object>

One webhook a world registers: what it listens to and what it runs

object
action
required

The action a delivery runs; empty when none is named

string
description
required

What it is for; empty when it declares nothing

string
events
required

The event names it accepts; empty for all

Array<string>
hasAutoRegister
required

True when the webhook registers itself with its source

boolean
name
required

The webhook’s name

string
source
required

The system that sends it

string