Brazebraze.com
Braze's API program shows meaningful strengths in discovery and overall API design, but partners and their AI agents face serious friction where it matters most: understanding what operations do, how errors should be handled, and how to run reliable, repeatable workflows. The two areas demanding immediate attention are Agent Understanding — where missing machine-readable errors, unclear operation semantics, and absent agent instructions leave AI agents guessing — and Agent Usability, where undocumented idempotency, rate-limit signaling, and pagination force partners to reverse-engineer critical reliability behaviors.
API DesignA clean, typed, well-governed API contract agents can reason about2 pass2 warn1 fail73B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Schema coverage & depthvia sdk | 22.9/25 | 1 of 12 public signatures use loose types (anyTypeRatio=0.083). Investigated: sdk 92%, spec 67%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| warn | Machine-readable, versioned contractvia spec | 18.8/25 | info.version="1.0.0" 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. |
| pass | Security & governance hygienevia spec | 15/15 | No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 100%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| pass | Example coveragevia sdk | 10/10 | README is present and includes a runnable quickstart. Investigated: sdk 100%, spec 0%, docs 0%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
| fail | Auth declared & discoverablevia spec | 0/25 | No securitySchemes declared. Investigated: spec 0%, docs 0%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples3 pass1 warn1 fail75B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Signup page at https://www.braze.com/get-started; no free-tier language detected in docs/pricing. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Description completenessvia spec | 15/15 | 88% description completeness (target 90%+). Investigated: spec 100%, sdk 75%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia sdk | 13/13 | Newest official SDK activity 2 day(s) ago. Investigated: sdk 100%, spec 0%, docs 0%. | A published changelog lets partners track changes without surprise. |
| warn | Quickstart presentvia docs | 12.5/25 | Quickstart page reachable (3 variants scanned starting at https://www.braze.com/docs/api/quickstart) but no runnable code sample detected in HTML or .md variant. Investigated: docs 50%. | A quickstart is the fastest path from landing page to first successful call. |
| fail | Code samples in docsvia docs | 0/18 | No detectable code samples across 20 sampled docs pages. Investigated: docs 0%. | Multi-language samples shorten time-to-first-call. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs2 pass2 warn0 fail81A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/braze, 53145 snippets). Investigated: docs 100%, sdk 100%, 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 | 15/30 | No llms.txt directive found in HTML of any of 1 pages. Investigated: docs 50%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| 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 docs0 pass3 warn3 fail46F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Agent-navigable, token-efficient docsvia docs | 15.1/22 | No pages support .md URLs (0/1 tested). Investigated: docs 69%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| warn | Docs structured datavia docs | 4/8 | JSON-LD on 9/20 assessed pages, but coverage is sparse or dateModified is missing. 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. |
| warn | Description consistency across surfaces | 1.8/7 | Mean pairwise description similarity across 2 surfaces (spec, docs) is 9% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| fail | Machine-readable errors (RFC 9457)via spec | 0/28 | No 4xx/5xx response codes (or default error response) documented anywhere in the spec. Investigated: spec 0%, docs 0%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| fail | Operation purpose clarityvia spec | 0/25 | 0% of operations are agent-inferable. Investigated: spec 0%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| 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. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them0 pass1 warn4 fail42F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Sandbox separationvia sdk | 10/20 | No test-mode flag or sandbox environment is exposed. Investigated: sdk 50%, spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
| fail | Idempotency documentedvia spec | 0/27 | 0% of mutating operations document idempotency. Investigated: spec 0%, docs 0%, sdk 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 | Pagination documented & consistentvia spec | 0/22 | 2 list endpoint(s) exist but no pagination params found. Investigated: spec 0%, docs 0%. | Consistent, documented pagination lets agents traverse collections. |
| 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 Braze — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (53,145) |
|---|---|
| APIs analyzed | 1 — Braze Audience Sync Partner Spec |