List goals

GET

/api/v1/agent-platform/goals

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

Returns every goal the planner knows about, with its tags, example phrasings, and output type.

Authorizations

apiKeyAuth
basicAuth

Responses

200

List of goals

*/*

Array<object>

One goal the agent platform can plan towards, as GET /agent-platform/goals lists it and as each agent nests it.

object

description

required

What achieving the goal means, as its definition states it

string

examples

required

Example requests the goal serves, such as I need a recipe for bread; empty when it declares none

Array<string>

unique items

name

required

Identifier the agent platform knows the goal by

string

outputType

Name of the type achieving the goal produces; null when it declares none

string

tags

required

Tags naming the kind of capability, such as billing; empty when it declares none

Array<string>

unique items