Muxmux.com
Mux's API program shows real strengths in discovery and machine-readable contract quality, giving partners a solid foundation to find and evaluate the API. However, two areas create meaningful friction for partners and their AI agents today: agent understanding (missing structured context files and metadata that agents rely on to act autonomously) and agent usability (no sandbox separation, no runnable collection with test scripts, and gaps in idempotency and rate-limit documentation).
API DesignA clean, typed, well-governed API contract agents can reason about2 pass3 warn0 fail77B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Machine-readable, versioned contractvia spec | 18.8/25 | info.version="v1" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 75%, docs 50%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia spec | 16.7/25 | 90% of operations have documented schemas (target 95%+). Investigated: spec 67%, sdk 0%. | 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 50%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| warn | Auth declared & discoverablevia spec | 12.5/25 | Authentication applied on 121/131 operations (partial coverage). Investigated: spec 50%, docs 50%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| pass | Example coveragevia docs | 10/10 | Code samples in 7 language(s) across docs (top: javascript, shell, typescript); 3/20 pages have ≥ 2 languages on the same page. Investigated: docs 100%, spec 0%, sdk 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 examples3 pass0 warn2 fail59D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Code samples in docsvia docs | 18/18 | Code samples in 7 language(s) across docs (top: javascript, shell, typescript); 3/20 pages have ≥ 2 languages on the same page. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Description completenessvia spec | 15/15 | 94% of operations + parameters have substantive descriptions. Investigated: spec 100%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog documented in the docs site at https://www.mux.com/docs/changelog. Investigated: spec 100%, docs 100%, sdk 100%. | A published changelog lets partners track changes without surprise. |
| fail | Self-service developer portalvia docs | 0/29 | No signup page detected across conventional paths (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free). Investigated: docs 0%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| fail | Quickstart presentvia docs | 0/25 | No quickstart/getting-started page found at the conventional paths. Investigated: docs 0%. | A quickstart is the fastest path from landing page to first successful call. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs2 pass2 warn0 fail82A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/mux, 12973 snippets). Investigated: docs 100%, cli 100%, mcp 100%, sdk 88%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | llms.txt present, valid & comprehensivevia docs | 24.4/30 | llms.txt covers 196/691 sitemap doc pages (28%); 495 missing; 17 llms.txt links not in sitemap (may indicate stale links or incomplete sitemap). Investigated: docs 81%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Docs reachable, not hard auth-gatedvia docs | 15/30 | 1 of 50 sampled pages return 200 for non-existent URLs (soft 404). Investigated: docs 50%. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
| pass | Crawlable / AEOvia wellknown | 12/12 | Docs paths crawlable by all monitored AI agents. 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 docs2 pass2 warn2 fail74B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | 9 distinct 4xx/5xx response codes documented. Investigated: docs 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| pass | Operation purpose clarityvia spec | 25/25 | 99% of operations have a clear summary + operationId an agent can select on. Investigated: spec 100%. | 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 | 14.3/22 | 1 of 44 pages have substantive content differences between markdown and HTML (avg 5% missing). Investigated: docs 65%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Description consistency across surfaces | 1.5/7 | Mean pairwise description similarity across 2 surfaces (spec, sdk) is 8% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| fail | Agent instructions file (AGENTS.md)via wellknown | 0/10 | No AGENTS.md at the site root or /.well-known/. 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. |
| fail | Docs structured datavia docs | 0/8 | Neither JSON-LD nor OpenGraph/meta tags detected across 4 assessed pages (3 JS-rendered). Investigated: docs 0%. | 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. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them1 pass0 warn4 fail46F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Pagination documented & consistentvia spec | 22/22 | Pagination params detected on 38 list endpoint(s). Investigated: spec 100%, docs 100%. | Consistent, documented pagination lets agents traverse collections. |
| fail | Idempotency documentedvia spec | 0/27 | 0% of mutating operations document idempotency. Investigated: spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| fail | Rate-limit signalingvia spec | 0/22 | No rate-limit response headers documented. Investigated: spec 0%, docs 0%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| fail | Sandbox separationvia spec | 0/20 | No sandbox/test server declared across 148 server entries; no test-key prefixes documented. 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 discovered for the org. Investigated: platform 0%. | A public, maintained collection with assertions is runnable truth agents validate against. |
Resources Discovered
The public resources we found for Mux — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (12,973) |
|---|---|
| APIs analyzed | 1 — Mux API |