Skip to content
Embabel Worlds

Return one handler's source and metadata

POST
/api/v1/admin/handlers/open
curl --request POST \
  --url 'http://localhost:11044/api/v1/admin/handlers/open?name=example' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
name
required
string

Name of the handler, as name in the POST /admin/handlers/list response; an exact match against every handler in the caller’s world, realm-shipped ones included. 400 when none has that name

Responses

Section titled “Responses”

200

Section titled “200”

The handler’s source and its triggers

Media typeapplication/json

One handler’s source and metadata, for round-tripping open → edit → save.

object
autonomous
required

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

boolean
description
required

One line describing what it does; the name when it was saved without one.

string
inputTypeNames
required

Domain types it consumes; empty means reaction-only.

Array<string>
unique items
name
required

The name to send back to save, which updates this handler in place.

string
outputTypeName
required

Domain type it returns, or ‘void’.

string
schedule

The 6-field cron expression saved with the handler, or null. A per-user schedule set through set-schedule is not reflected here; list reports it.

string
signalType
required

Signal.typeName (or simple name) that fires it; ‘*’ = none.

string
skills
required

Skills bundled with it, round-tripped so an edit does not drop them.

Array<string>
source
required

The TypeScript handler body, to edit and send back to save.

string

Example generated

{
  "autonomous": true,
  "description": "example",
  "inputTypeNames": [
    "example"
  ],
  "name": "example",
  "outputTypeName": "example",
  "schedule": "example",
  "signalType": "example",
  "skills": [
    "example"
  ],
  "source": "example"
}

400

Section titled “400”

No such handler

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"
}

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"
}