Agent-ready OpenAPI document · curated by JenticIOTHome Automationbearer6 EndpointsREST
Know of an official OpenAPI document? Contribute it →
For Agents
Control LIFX smart bulbs and groups with state changes, toggles, and breathe effects across 6 bearer-authenticated endpoints.
Use for: Turn off all LIFX lights in the kitchen group, Set my bedroom LIFX bulb to warm white at 30% brightness, Run a breathe effect on the living room LIFX strip with red and blue, List all LIFX bulbs registered to my account
Not supported: Does not handle non-LIFX smart-home devices, security cameras, or HVAC control - use for LIFX Wi-Fi bulb and strip control only.
Jentic publishes the only available OpenAPI specification for LIFX HTTP API, keeping it validated and agent-ready. The LIFX HTTP API controls Wi-Fi-connected LIFX smart bulbs, strips, and panels using a flexible selector syntax that targets individual lights, groups, locations, or scenes. Six endpoints cover state queries, state changes, multi-selector batch updates, delta adjustments, on/off toggling, and breathe color effects. Authentication uses an LIFX personal access token issued from the cloud account portal.
Install Jentic One Beta
Connect the LIFX HTTP API to your agent
Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the LIFX HTTP 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://jentic.com/install.sh?src=apis&api=%2Fapis%2Flifx.com%2Flifx" | sh2
Step 2: Agent machine
# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL "https://jentic.com/install.sh?src=apis&api=%2Fapis%2Flifx.com%2Flifx" | 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 LIFX HTTP API.
Set color, brightness, and power state on a single bulb or group of LIFX lights using selector syntax
Apply different states to multiple LIFX selectors in a single batched request
Toggle LIFX lights on or off based on their current group state
Run a breathe effect that fades between two LIFX colors over a configurable cycle
Apply a delta adjustment to current LIFX bulb state for relative brightness or hue changes
List LIFX bulbs visible to the authenticated account filtered by selector
Use Cases
Patterns agents use LIFX HTTP API for, with concrete tasks.
★ Smart Home Routines
Build morning, evening, and away routines that change LIFX bulb color, brightness, and power state on schedule. The /lights/{selector}/state endpoint accepts color, brightness, duration, and power in a single call so transitions feel smooth. Setup takes under an hour with a personal access token.
Set selector 'group:Bedroom' to color 'kelvin:2700' at brightness 0.4 over 30 seconds at 7am
Notification Light Cues
Use LIFX bulbs as ambient notification cues - flash red for an incident, breathe green for a build success, dim white for focus mode. The breathe effect endpoint supports two-color fades with configurable period, cycles, and persistence. Pairs with monitoring tools to surface system state in physical space.
Trigger a breathe effect on selector 'label:status' with red and white, period 2 seconds, 3 cycles
Multi-Room Scene Activation
Apply different states to multiple LIFX selectors at once with the /lights/states endpoint, enabling whole-home scenes like 'movie night' that change living-room, kitchen, and hallway lights with one request. Useful for voice-assistant integrations and scene managers.
Set selector 'group:LivingRoom' to dim warm white and selector 'group:Kitchen' to off in a single batched request
AI Agent Lighting Assistant
An AI agent uses Jentic to discover the LIFX state and breathe operations by intent and applies lighting changes in response to natural-language prompts. The agent never holds the raw token; Jentic injects credentials per execution, keeping the LIFX account isolated from the agent's prompt context.
Search Jentic for 'set LIFX bulb color', load the /lights/{selector}/state schema, and execute it for selector 'all' with color 'blue' brightness 0.5
Key Endpoints
6 endpoints — jentic publishes the only available openapi specification for lifx http api, keeping it validated and agent-ready.
METHOD
PATH
DESCRIPTION
GET
/lights/{selector}
List lights matching a selector
PUT
/lights/{selector}/state
Set state for lights matching a selector
PUT
/lights/states
Set different states across multiple selectors
POST
/lights/{selector}/state/delta
Apply a delta adjustment to current state
POST
/lights/{selector}/toggle
Toggle lights on or off
POST
/lights/{selector}/breathe
Run a breathe color-fade effect
GET
/lights/{selector}
List lights matching a selector
PUT
/lights/{selector}/state
Set state for lights matching a selector
PUT
/lights/states
Set different states across multiple selectors
POST
/lights/{selector}/state/delta
Apply a delta adjustment to current state
POST
/lights/{selector}/toggle
Toggle lights on or off
POST
/lights/{selector}/breathe
Run a breathe color-fade effect
Jentic AI Readiness Score
This API is usable in Jentic One now. Its AI-readiness score against Jentic's framework shows where it stands today and where improvements would make it even easier for agents to use.
L
LIFX HTTP API
- Foundational (D+)49/100
84
Foundational Compliance63
Developer Experience & Jentic Compatibility38
AI-Readiness & Agent Experience34
Agent Usability60
Security69
AI DiscoverabilityPowered by JenticScoring Framework 0.2.0 | Scoring Engine 0.3.10
Show dimension breakdown
84
Foundational Compliance
Base layer of spec validity and structural soundness.
Grade: ASignals: 4
99%
Lint Results
Aggregated quality score from linter diagnostics, weighted by severity.
63%
Resolution Completeness
Percentage of `$ref` references that resolve successfully.
100%
Specification Validity
Checks whether the API description parses successfully and conforms to its declared specification (e.g., OpenAPI).
75%
Structural Integrity
Structural correctness score based on schema issues using logarithmic dampening.
63
Developer Experience & Jentic Compatibility
Clarity, completeness, and ingestion readiness for developers and tooling.
Grade: B-Signals: 4
0%
Example Density
How richly the API is illustrated with examples.
100%
Example Validity
Percentage of examples that conform to their schemas.
50%
Response Coverage
Percentage of operations with complete response definitions (success, client error, server error).
100%
Tooling Readiness
Health of API ingestion, bundling, and resolution within Jentic pipelines.
38
AI-Readiness & Agent Experience
Semantic breadth, depth, and agent comprehension for AI systems.
Grade: FSignals: 4
17%
Description Coverage
Coverage of descriptions across API elements.
0%
Error Standardization
Coverage of RFC 9457 Problem Details for error responses.
83%
OperationId Quality
Coverage, uniqueness, and casing consistency of operationIds for AI inference.
50%
Summary Coverage
Coverage of summaries across operations/tags/info.
34
Agent Usability
Functional utility, complexity comfort, and AI orchestration readiness.
Grade: FSignals: 1
34%
Complexity Comfort
Agent comfort level based on API operational and structural complexity.
60
Security
Trust, risk posture, and security compliance.
Grade: B-Signals: 1
60%
Authentication Strength
Average quality of security schemes based on authentication method strength (weakest link for OAuth2).
69
AI Discoverability
Findability, semantic richness, and reasoning readiness.
Grade: B+Signals: 1
69%
Descriptive Richness
Clarity and depth of descriptions across API elements.
Score it yourself
Every API in the directory is allowlisted, so you can re-score it with no key required.
npx @jentic/api-scorecard-cli score <openapi-url>Why Jentic?
What agents get from Jentic-routed access to this vendor.
Setup
Wiring the LIFX HTTP API by hand means setting its bearer app token, learning the selector syntax that targets bulbs and groups, and calling api.lifx.com yourself. Through Jentic you install once, import the LIFX HTTP API from the API Directory, store the token once, and your agent calls it.
Permission scoping
LIFX puts the selector in the URL path (/lights/{selector}/state, /toggle, /breathe), so a rule can pin your agent to one light or group: it acts only on that selector. You choose the operations it may call, so effects like breathe are not included unless you add them.
Credential isolation
Your LIFX bearer token is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
Intent-based discovery
Agents search Jentic by intent such as 'turn off all my LIFX lights' or 'set a bulb to warm white', and Jentic returns the matching LIFX operation with its selector and state schema so the agent calls the right endpoint without browsing the reference docs.
Related APIs
Alternatives and complements available in the Jentic catalogue.
FAQs
Specific to using LIFX HTTP API through Jentic.
Why is there no official OpenAPI spec for LIFX HTTP API?
LIFX does not publish a maintained OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call the LIFX HTTP API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.
What authentication does the LIFX HTTP API use?
LIFX uses HTTP bearer authentication with a personal access token issued from the LIFX cloud account portal. Jentic stores the token in your Jentic One instance and injects it on each request - the raw token never appears in the agent's context.
Can I control multiple LIFX bulbs in a single request?
Yes. PUT /lights/states accepts an array of selector-and-state pairs, so an agent can set different colors and brightness levels across rooms in one batched call. PUT /lights/{selector}/state can also target groups using selectors like 'group:Kitchen' or 'all'.
What are the rate limits for the LIFX HTTP API?
LIFX limits cloud requests to roughly 60 per minute per token. Sustained traffic above that returns HTTP 429. For low-latency lighting, prefer the on-LAN local protocol over the HTTP API.
How do I run a breathe effect through Jentic?
Run pip install jentic, then search Jentic with 'breathe effect on LIFX lights' to retrieve the /lights/{selector}/breathe operation. Execute it with from_color, color, period, and cycles; Jentic handles the bearer token.
Is the LIFX HTTP API free?
Yes. The LIFX HTTP API is free for owners of LIFX hardware. No subscription is required - only a personal access token tied to the LIFX account that owns the bulbs.
Can I limit what my agent is allowed to do with the LIFX HTTP API?
Yes. Because you run Jentic One yourself, your own rules decide which LIFX operations and credentials the agent may use. LIFX carries the target in the selector portion of the URL path, so a rule can pin the agent to a single bulb or group like 'group:Kitchen' and it will act only on that selector. You also choose which operations it can call, so state changes, toggles, deltas, or the breathe effect are each available only if you grant them.
GET STARTED