Hightouchhightouch.com
Hightouch's API program shows strong discoverability fundamentals, but partners and their AI agents face real friction in three critical areas: the API contract lacks security and governance hygiene that enterprise partners require before committing to an integration; there is no runnable, tested collection giving agents the concrete request/response shapes they need to integrate correctly; and the documentation lacks the machine-readable signals (structured data, agent instruction files) that AI agents depend on to parse and act on your APIs without guessing. Prioritize closing the security contract and runnable truth gaps first — these block partner confidence and agent-driven integration alike — then layer in the agent-readiness enhancements to make your docs a fully autonomous-friendly front door.
API DesignA clean, typed, well-governed API contract agents can reason about1 pass0 warn1 fail55D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Example coveragevia docs | 10/10 | Code samples in 8 language(s) across docs (top: php, shell, csharp); 3/20 pages have ≥ 2 languages on the same page. Investigated: docs 100%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
| fail | Security & governance hygienevia wellknown | 0/15 | No security.txt at /.well-known/security.txt or /security.txt. Investigated: wellknown 0%. | No leaked secrets, no critical lint violations, no OWASP API Top-10 spec smells, and a published vulnerability-disclosure channel. |
| na | Machine-readable, versioned contract | —/25 | No surface produced evidence for this capability in this run. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| na | Schema coverage & depth | —/25 | No surface produced evidence for this capability in this run. | Typed, complete request/response schemas are what make agent function-calling possible. |
| na | Auth declared & discoverable | —/25 | No surface produced evidence for this capability in this run. | 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 examples2 pass1 warn1 fail62C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Code samples in docsvia docs | 18/18 | Code samples in 8 language(s) across docs (top: php, shell, csharp); 3/20 pages have ≥ 2 languages on the same page. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| pass | Changelog publishedvia sdk | 13/13 | Newest official SDK activity 16 day(s) ago. Investigated: sdk 100%. | A published changelog lets partners track changes without surprise. |
| warn | Quickstart presentvia docs | 12.5/25 | Quickstart page reachable (1 variants scanned starting at https://hightouch.com/docs/syncs/create-your-first-sync) 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 | 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. |
| na | Description completeness | —/15 | No surface produced evidence for this capability in this run. | Complete descriptions are the context humans and agents need to use endpoints. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs1 pass3 warn0 fail82A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/hightouch, 13922 snippets). Investigated: docs 100%, cli 100%, sdk 50%, mcp 0%, wellknown 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/50 sampled 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 | 18.8/30 | No llms.txt directive found in HTML of any of 50 sampled pages. Investigated: docs 63%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Crawlable / AEOvia wellknown | 9/12 | Sitemap present (3 entries) but carries no lastmod values. Investigated: wellknown 75%. | 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 pass1 warn2 fail53D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Agent-navigable, token-efficient docsvia docs | 14.1/22 | No sampled pages support .md URLs (0/50 tested). Investigated: docs 64%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| 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. |
| na | Machine-readable errors (RFC 9457) | —/28 | No surface produced evidence for this capability in this run. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| na | Operation purpose clarity | —/25 | No surface produced evidence for this capability in this run. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| 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 them0 pass0 warn1 fail40F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| 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. |
| na | Idempotency documented | —/27 | No surface produced evidence for this capability in this run. | Documented idempotency lets agents retry safely. |
| na | Rate-limit signaling | —/22 | No surface produced evidence for this capability in this run. | Machine-readable rate-limit headers let agents throttle adaptively. |
| na | Pagination documented & consistent | —/22 | No surface produced evidence for this capability in this run. | Consistent, documented pagination lets agents traverse collections. |
| na | Sandbox separation | —/20 | No surface produced evidence for this capability in this run. | An isolated environment lets agents exercise destructive operations safely. |
Resources Discovered
The public resources we found for Hightouch — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (13,922) |
|---|