Get action details

GET

/api/v1/actions/spec/{name}

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

Returns the full spec for a world action. Only PromptedActionSpecs in the world (not realms) include editable fields.

Authorizations

apiKeyAuth
basicAuth

Parameters

Path Parameters

name

required

string

Name of the action, as listed by GET /api/v1/actions; matched exactly. A world action’s YAML at config/actions/<name>.yml is read fresh from disk, otherwise any loaded action of that name (realm-shipped included) is returned with editable false; no match is 404

Responses

200

Action spec

*/*

One action’s spec. The prompt, types, tools, references and model are present only for a prompted action, and absent, not null, for any other

object

description

required

What the action does

string

editable

required

True only for a prompted action defined directly in this world, which is the only kind editable here

boolean

inputTypeNames

The types the action takes. Prompted actions only

Array<string>

unique items

llmModel

The model the action runs on. Prompted actions only, and null there for the default

string

llmTemperature

The sampling temperature. Prompted actions only, and null there for the default

number format: double

name

required

The action’s name

string

outputTypeName

The type the action produces. Prompted actions only, and null there when none is set

string

prompt

The prompt template. Prompted actions only

string

references

The references the action reads. Prompted actions only

Array<string>

stepType

required

The kind of step the spec defines

string

tools

The tools the action may call. Prompted actions only

Array<string>

404

Action not found

*/*

A refused action operation: not found, not editable, not deletable, or a compilation that failed

object

message

required

Why, written to be shown, naming the action

string

status

required

Always error

string

Allowed values: error