Skip to content
Embabel Worlds

List the user's handlers plus inactive realm-shipped handlers available to adopt

POST
/api/v1/admin/handlers/list
curl --request POST \
  --url http://localhost:11044/api/v1/admin/handlers/list \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”

The user’s handlers, and the realm ones they could adopt

Media typeapplication/json

The handlers this user has, and the realm-shipped ones they could adopt.

object
available
required

Realm-shipped handlers that are not active for this user, to adopt.

Array<object>

A realm-shipped handler available to adopt, which this user has not enabled.

object
name
required

The realm handler’s name, to pass to set-enabled to adopt it.

string
signalType
required

The signal type that fires it once adopted; ‘*’ = none.

string
yours
required

Handlers authored in this user’s world, sorted by name. Realm-shipped handlers are never listed here.

Array<object>

A handler belonging to this user, with its triggers and whether it is live.

object
active
required

Whether it currently fires. A saved handler that is off changes nothing.

boolean
autonomous
required

When true it may apply external/write effects; when false it runs observe-only.

boolean
inputTypeNames
required

Domain types it consumes; empty means reaction-only (dispatcher, never planner).

Array<string>
unique items
name
required

The handler’s name, as open, save and the other operations take it.

string
outputTypeName
required

Domain type it returns, or ‘void’.

string
schedule

Its 6-field cron expression, or null when not scheduled.

string
signalType
required

The signal type that fires it; ‘*’ = none.

string
skills
required

Skills bundled with it.

Array<string>

Example generated

{
  "available": [
    {
      "name": "example",
      "signalType": "example"
    }
  ],
  "yours": [
    {
      "active": true,
      "autonomous": true,
      "inputTypeNames": [
        "example"
      ],
      "name": "example",
      "outputTypeName": "example",
      "schedule": "example",
      "signalType": "example",
      "skills": [
        "example"
      ]
    }
  ]
}

401

Section titled “401”

No authenticated principal

Media typeapplication/json

A refusal carrying only a human-readable reason.

object
error
required

What went wrong, in the terms the caller can act on.

string

Example generated

{
  "error": "example"
}