List actions in full

GET

/api/v1/actions

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

Returns every action the planner knows about, with its input/output types and whether it can be deleted from here. ‘deletable’ is true only for actions whose YAML lives directly under this world’s config/actions directory — realm-shipped and platform-defined actions report false.

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of actions

*/*

Array<object>

One action the agent platform can plan with, as GET /actions lists it and as each agent from GET /agent-platform/agents nests it.

object

canRerun

required

True when the action may run again in an agent process where it has already run

boolean

deletable

required

True only when the action’s YAML lives directly in this world’s config/actions directory, so DELETE /actions/spec/{name} can remove it; false for realm-shipped and platform-defined actions

boolean

description

required

What the action does, as its definition states it

string

inputTypes

required

Names of the types the action needs as input

Array<string>

unique items

name

required

Identifier the agent platform knows the action by; for a world action, the name /actions/spec/{name} takes

string

outputTypes

required

Names of the types the action produces

Array<string>

unique items

readOnly

required

True when the action declares that it has no external side effects

boolean