Ubiquitiubiquiti.com
Ubiquiti's API program shows genuine strength in API design, auth security, and agent discoverability — partners and their agents can find and trust the contract. However, the program has two critical gaps that block partners from safely and quickly getting to value: there is no sandbox environment, no runnable collection, and no self-service onboarding path, meaning every new partner must touch production before writing a single line of integration code.
API DesignA clean, typed, well-governed API contract agents can reason about3 pass2 warn0 fail83A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable, versioned contractvia spec | 25/25 | The API declares version "1.0.0" and uses url-based versioning, so an agent can pin to a stable contract. Investigated: spec 100%, docs 100%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia spec | 18.1/25 | Only 63% of the 8 operations document request and response schemas, so an agent can't do function-calling against most endpoints. Investigated: spec 72%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| warn | Auth declared & discoverablevia docs | 12.5/25 | The spec declares no authentication scheme, so an agent can't tell how to authenticate a request. Investigated: docs 50%, spec 25%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| pass | Example coveragevia spec | 10/10 | Only 28% of parameters and responses (52 of 189) include example values, so an agent has little grounding in real payload shapes. Investigated: spec 100%, docs 0%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples2 pass0 warn3 fail55D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://developer.ui.com/mobility/v1.0.0/getting-started includes a runnable first-call code sample. Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Description completenessvia spec | 15/15 | Only 43% of operations and parameters have descriptions (63 of 73 ops, 0 of 178 params), leaving an agent to guess what most endpoints do. Investigated: spec 100%. | Complete descriptions are the context humans and agents need to use endpoints. |
| fail | Self-service developer portalvia docs | 0/29 | No self-service signup detected — no signup link on the homepage or docs, and no conventional signup path (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free, /join, /create-account, /account/signup, /auth/signup, /users/sign_up) resolved — so an agent can't onboard on its own. Investigated: docs 0%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| fail | Code samples in docsvia docs | 0/18 | No code samples detected across 20 sampled docs pages, so a coding agent gets no ready-to-use examples. Investigated: docs 0%. | Multi-language samples shorten time-to-first-call. |
| fail | Changelog publishedvia spec | 0/13 | No changelog link or mention appears in the spec, so an agent can't tell what changed before something breaks. Investigated: spec 0%, docs 0%. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs2 pass2 warn0 fail85A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/help_ui_hc_en-us, 219 snippets). Investigated: docs 100%, sdk 0%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | Docs reachable, not hard auth-gatedvia docs | 22.5/30 | Server ignores Accept: text/markdown header (0/1 pages return markdown). Investigated: docs 75%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| warn | llms.txt present, valid & comprehensivevia docs | 20.6/30 | No llms.txt directive found in HTML of any of 1 pages. Investigated: docs 69%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| pass | Crawlable / AEOvia wellknown | 12/12 | No robots.txt on the docs host, so AI crawlers are unrestricted and can read the docs. Investigated: wellknown 100%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs1 pass3 warn1 fail75B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | error codes is documented on the docs site at https://developer.ui.com/network/v10.4.57/error-handling, even though it isn't declared in the API spec. Investigated: docs 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| warn | Operation purpose clarityvia spec | 16.7/25 | Only 0% of operations (0 of 74) have a clear summary plus descriptive name, so an agent must guess purpose from the URL path for most. Investigated: spec 67%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| warn | Agent-navigable, token-efficient docsvia docs | 16.5/22 | No pages support .md URLs (0/1 tested). Investigated: docs 75%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Docs structured datavia docs | 4/8 | Only OpenGraph/meta tags across 19 assessed pages — no JSON-LD for AI answer engines to cite. Investigated: docs 50%. | Structured data (JSON-LD/schema.org) on docs pages gives agents an unambiguous parse target and is what answer engines cite. Detected on the JS-rendered head (Firecrawl) for a bounded page budget, so JS-injected JSON-LD is now caught; pages we can't render are excluded rather than failed. |
| fail | Agent instructions file (AGENTS.md)via wellknown | 0/10 | No AGENTS.md at the site root or /.well-known/, so coding agents have no ready-made setup and usage instructions. Investigated: wellknown 0%. | An AGENTS.md gives coding agents explicit setup, auth, and usage instructions to interpret and operate the API — beyond llms.txt's link index. |
| na | Description consistency across surfaces | —/7 | Only 1 surface description(s) with ≥6 tokens available; need at least 2 to compare. | Every surface tells the same story about what the product is. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them1 pass2 warn2 fail53D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Rate-limit signalingvia spec | 22/22 | rate-limit behavior is documented on the docs site at https://developer.ui.com/usage/api/rate-limits, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| warn | Pagination documented & consistentvia spec | 11/22 | The 17 list endpoint(s) expose no pagination parameters, forcing an agent into all-or-nothing reads. Investigated: spec 50%, docs 50%. | Consistent, documented pagination lets agents traverse collections. |
| warn | Idempotency documentedvia spec | 2.7/27 | Only 0% of mutating operations (0 of 36) document idempotency, so an agent's retries can create duplicate writes. Investigated: spec 10%, docs 10%. | Documented idempotency lets agents retry safely. |
| fail | Sandbox separationvia spec | 0/20 | None of the 2 declared server(s) is a sandbox/test host, and no test-key prefixes are documented, so agents can only hit production. Investigated: spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
| fail | Runnable collection with test scriptsvia platform | 0/9 | No public Postman workspace found for the org, so there's no runnable collection an agent can execute against. Investigated: platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
Resources Discovered
The public resources we found for Ubiquiti — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.