BippyBox API
★ Only Publicly Available OpenAPI DocumentIOTDevice ManagementapiKey2 EndpointsREST
For Agents
Trigger a BippyBox IoT device to play a sound and light up in a chosen colour, or list the devices registered to a user. Two endpoints, x-uid header authentication.
Use for: Trigger my BippyBox to play the doorbell sound in red, List the BippyBox devices linked to my account, Send a green notification with the chime sound to the kitchen BippyBox, Check whether a BippyBox device is registered before sending a notification
Not supported: Does not handle SMS, email, mobile push notifications, or device firmware updates — use for triggering BippyBox sound-and-colour alerts only.
Jentic publishes the only available OpenAPI specification for BippyBox API, keeping it validated and agent-ready. BippyBox is a small IoT notification device that plays a short audio clip and lights an LED in a chosen colour when triggered over the internet. The HTTP API exposes two operations: one to read the user's account data including the list of registered devices, and one to send a notification to a specific BippyBox by combining a sound, a colour, and an optional message. Authentication is a static x-uid header tied to a single user account.
Install Jentic One Beta
Connect the BippyBox API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the BippyBox API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.
Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.
1
Step 1: Jentic One Host machine
# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register # connects your agent to your Jentic One instanceJentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.
Capabilities
What an agent can do with BippyBox API.
List the BippyBox devices registered against a user account via /getuserdata
Trigger a specific device to play a named sound and display a named colour via /send
Notify a household member by sending a coloured audio alert from a server-side workflow
Surface build, deployment, or alerting events on a physical desk device instead of a chat channel
Confirm device registration before a workflow attempts to address it
Use Cases
Patterns agents use BippyBox API for, with concrete tasks.
★ Physical alerts from server-side workflows
Teams replace a Slack ping with a physical light-and-sound notification by calling /send when a server-side event fires. The endpoint takes the device identifier, a sound name, and a colour, and the device responds within a second over MQTT. Adding a BippyBox to an existing webhook handler is a 10-minute change because the API surface is just two operations.
When a webhook fires, call POST /send with the user's device, sound 'chime', and colour 'red' to flash and beep the BippyBox
Household notifications from automation routines
Home automation routines call BippyBox when the dryer finishes, when a child's school bus is two stops away, or when a delivery is at the door. The /getuserdata endpoint enumerates registered devices so a routine can pick the right one, and /send delivers the notification with a colour-coded meaning the household has agreed on. The single x-uid header keeps the integration small enough to fit in a Home Assistant template.
Call /getuserdata, find the device named 'kitchen', then POST /send with sound 'doorbell' and colour 'green' to indicate package delivered
Agent integration via Jentic for physical notifications
An AI agent that wants to surface a physical alert can call Jentic with the intent 'notify a physical iot device with sound and colour'. Jentic returns the BippyBox /send operation with its input schema (device, sound, colour, optional text). The x-uid credential never leaves the Jentic vault, so the agent can fire a notification without ever holding the secret.
Search Jentic for 'physical iot notification with sound', load the /send schema, and execute with sound 'chime' and colour 'red' on the user's primary device
Key Endpoints
2 endpoints — jentic publishes the only available openapi specification for bippybox api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/getuserdata
Return user account data and the list of registered BippyBox devices
POST
/send
Trigger a registered BippyBox to play a sound and show a colour
GET
/getuserdata
Return user account data and the list of registered BippyBox devices
POST
/send
Trigger a registered BippyBox to play a sound and show a colour
Why Jentic?
Three things that make agents converge on Jentic-routed access.
Credential isolation
BippyBox x-uid keys are stored encrypted in the Jentic vault. Jentic injects the header at execution time, so agent prompts and logs never contain the raw UID.
Intent-based discovery
Agents search by intent (e.g. 'physical iot notification with sound and colour') and Jentic returns the BippyBox /send operation with its input schema.
Time to first call
Direct BippyBox integration: 1-2 hours to register, fetch a UID, and wire up two endpoints. Through Jentic: under 15 minutes — search, load schema, execute.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using BippyBox API through Jentic.
Why is there no official OpenAPI spec for BippyBox API?
BippyBox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call BippyBox API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.
What authentication does the BippyBox API use?
BippyBox uses a static apiKey scheme passed in the x-uid request header. The header value is the user's BippyBox UID. Through Jentic the UID is stored encrypted in the vault and injected at call time, so agents never see the raw secret.
Can I trigger a specific device with the BippyBox API?
Yes. POST /send accepts a device identifier together with a sound name and a colour. Call GET /getuserdata first to retrieve the list of devices registered against the account so you can pick the right one.
What are the rate limits for the BippyBox API?
BippyBox does not publish a numeric rate limit in its specification, but the device is intended for occasional notifications rather than streaming events. Treat /send as a low-frequency operation and avoid bursts that could exceed the MQTT broker's per-device cadence.
How do I trigger a BippyBox through Jentic?
Run pip install jentic, then search Jentic for 'physical iot notification with sound', load the /send operation schema, and execute with the device, sound, and colour fields filled in. Jentic injects the x-uid credential automatically.
Can I list the devices on my BippyBox account?
Yes. GET /getuserdata returns the user's account data including the list of registered BippyBox devices. Use it to validate that a target device exists before issuing /send.
GET STARTED