Publish what this machine can be asked to do

POST

/api/v1/sensor/capabilities

curl --request POST \
  --url http://localhost:11044/api/v1/sensor/capabilities \
  --header 'Content-Type: application/json' \
  --header 'X-Embabel-Api-Key: <X-Embabel-Api-Key>' \
  --data '{ "verbs": [ { "args": { "additionalProperty": "example" }, "description": "example", "group": "example", "name": "example" } ] }'

• Your world, at the port the installer gives it

The sensor’s verb catalog for the consent groups its user has enabled. Replaces the previous catalog; an empty list withdraws every verb.

Authorizations

• apiKeyAuth
• basicAuth

Request Body^required

The verbs this machine can be asked to run, each with its name, consent group, description and named args; replaces the authenticated user’s previous catalog in full, and an empty or omitted verbs withdraws every verb

Media typeapplication/json

The sensor’s whole verb catalog for the consent groups its user has enabled. It replaces the one published before

object

verbs

required

Every verb the machine now offers. Empty or absent withdraws them all. The appliance offers them only while the sensor keeps polling the outbox

Array<object>

One verb the user’s machine offers, as the sensor declares it to POST /sensor/capabilities

object

args

required

Each argument’s name mapped to what it means. Empty for a verb that takes none

object

key

additional properties

string

description

required

What the verb does, in words shown to the assistant’s model

string

group

required

The consent group the verb belongs to, as the sensor names it (the Me app uses see and act). The appliance does not interpret it

string

name

required

Verb name, carried as a command’s kind when the verb is asked for, e.g. tabs.find

string

Example ^generated

{
  "verbs": [
    {
      "args": {
        "additionalProperty": "example"
      },
      "description": "example",
      "group": "example",
      "name": "example"
    }
  ]
}

Responses

200

OK