Upload Ability

This endpoint uses multipart/form-data with a file upload. Use the cURL or Python example below. Names must be unique on your account. Calling this with an existing name returns Ability with same name already exists. Delete the existing Ability first to replace it.Trigger words must also be unique across the Abilities on your account. A phrase already claimed by another installed Ability is rejected with what is already exists in one of your installed capability.

Endpoint

POST https://app.openhome.com/api/capabilities/add-capability/

Send the request as multipart/form-data.

Headers

string

required

Your OpenHome API key.

Form fields

string

required

Ability name. Must be unique on your account, and must be alphanumeric. Hyphens are rejected, so a folder named my-skill uploads as myskill.

string

required

One of skill, brain_skill, background_daemon, or local.

string

required

One-line description.

string

required

Comma-separated trigger phrases. Example: hey skill, activate skill.

file

required

Zipped Ability package. Accepted content types: application/zip, application/x-zip, application/x-zip-compressed, application/octet-stream.

file

Optional icon.

integer

Install the Ability into a single Agent. Omit it to add the Ability to your account globally.

Example request

cURL

curl -X POST https://app.openhome.com/api/capabilities/add-capability/ \
  -H "X-API-KEY: YOUR_KEY" \
  -F "name=myskill" \
  -F "category=skill" \
  -F "description=Greets the user" \
  -F "trigger_words=hey skill, activate skill" \
  -F "zip_file=@./my-skill.zip"

Python

import requests

with open("my-skill.zip", "rb") as f:
    requests.post(
        "https://app.openhome.com/api/capabilities/add-capability/",
        headers={"X-API-KEY": "YOUR_KEY"},
        data={
            "name": "myskill",
            "category": "skill",
            "description": "Greets the user",
            "trigger_words": "hey skill, activate skill",
        },
        files={"zip_file": f},
    )

API & SDK

Endpoints

Endpoint

Headers

Form fields

Example request

​Endpoint

​Headers

​Form fields

​Example request

Endpoint

Headers

Form fields

Example request