Codestin Search App

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:

Style	Used by	How
`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

Your API key alone is enough for every endpoint on this page. If you are working from a browser session you may send that session’s JWT as Authorization: Bearer YOUR_JWT on the /api/capabilities/* and /api/personalities/* endpoints instead.

Never send your API key as a Bearer token. The server validates Bearer credentials as JWTs and rejects an API key with token_not_valid. Use the X-API-KEY header for those endpoints.

Include the trailing slash on every path. Without it the request is answered with a 301 redirect, which drops the body and method on some clients.

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-capabilities/

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/

Additional endpoints

These routes are used by the OpenHome CLI and the VS Code extension. They authenticate the same way as the endpoints above.

Endpoint	Purpose
`POST /api/sdk/verify_apikey`	Check that an API key is valid. Send `api_key` in the JSON body.
`POST /api/sdk/get_personalities`	List your Agents. Send `api_key` in the JSON body.
`GET /api/capabilities/get/template-file/{capability_id}/`	Download an Ability’s current source as a zip.
`GET /api/capabilities/get/installed-capability/by-capability/{capability_id}/`	The installed record for an Ability, including its effective trigger words and its version history.
`POST /api/capabilities/validate/release-code/{release_id}/`	Update an existing release in place. Multipart, with a flat zip. Send `committed=false` to save a draft, or `committed=true` with a `commit_message` to publish a version.
`POST /api/capabilities/uninstall-capability/{capability_id}/`	Uninstall an Ability without deleting it from your account.
`GET /api/capabilities/get/capability-templates/`	The Ability templates available to scaffold from.
`GET /api/devkit/get-devices/`	The DevKits registered to your account. Returns an empty array when none are paired.
`GET /api/devkit/get-firmware/`	The firmware images available for a DevKit, each with `id`, `name`, `version`, and `created_at`.

API & SDK

Endpoints

API Reference

Authentication

Endpoints

List Agents

Edit Agent

Upload Ability

Get Ability

List Abilities

List Installed Abilities

Enable / Disable Ability

Delete Ability

Additional endpoints

Categories

​Authentication

​Endpoints

List Agents

Edit Agent

Upload Ability

Get Ability

List Abilities

List Installed Abilities

Enable / Disable Ability

Delete Ability

​Additional endpoints

​Categories

Authentication

Endpoints

Additional endpoints

Categories