Skip to main content
Most developers build on OpenHome through the Dashboard. This reference is for when you need programmatic access — scripting, CI pipelines, or tools like the OpenHome CLI.

​
Authentication

All endpoints require an OpenHome API key. Get one from Settings → API Keys.
The Try-It playground saves your key in your browser’s local storage. If you enter your real production key to test an endpoint, clear it when you’re done:
  • Open browser DevTools → Application tab → Local Storage → this site → delete the entry, or
  • Use a separate test key (revocable from Dashboard → Settings → API Keys) for playground testing and rotate it regularly.
Never test with a key that’s also used in production on a shared or public machine.
Two auth styles depending on the endpoint family:
StyleUsed byHow
X-API-KEY header/api/capabilities/* and /api/personalities/*Set X-API-KEY: YOUR_KEY
api_key body field/api/sdk/*Include "api_key": "YOUR_KEY" in the JSON body

​
Endpoints

List Agents

GET /api/personalities/get-all-personalities/

Edit Agent

PUT /api/personalities/edit-personality/

Upload Ability

POST /api/capabilities/add-capability/

Get Ability

GET /api/capabilities/get-capability/{id}/

List Abilities

GET /api/capabilities/get-all-capability/

List Installed Abilities

GET /api/capabilities/get-installed-capabilities/

Enable / Disable Ability

PUT /api/capabilities/edit-installed-capability/{id}/

Delete Ability

POST /api/capabilities/delete-capability/{id}/