Smarshsmarsh.com
Smarsh's API program shows meaningful strengths in documentation crawlability and reachability, but two areas are holding back partner activation: partners and their AI agents have no self-service entry point — no signup path, no quickstart, and no runnable collection to make a first call — and the API surface is essentially invisible to the agent ecosystem, lacking the machine-readable files and registry presence that modern coding agents rely on. Fixing self-service onboarding and agent-readable infrastructure should be the immediate priority, as they directly block partner time-to-value and automated integration workflows.
API DesignA clean, typed, well-governed API contract agents can reason about0 pass0 warn1 fail40F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| fail | Security & governance hygienevia wellknown | 0/15 | No security.txt found at /.well-known/security.txt or /security.txt, so there's no machine-readable security contact for agents or researchers. Investigated: wellknown 0%. Fix: Publish an RFC 9116 security.txt with a Contact line and a future Expires date. | 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 call an API when they can determine its auth posture — a declared scheme, or an explicit statement that none is required. |
| na | Example coverage | —/10 | No surface produced evidence for this capability in this run. | 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 examples0 pass0 warn2 fail40F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| 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%. Fix: Publish a public signup endpoint and link it from your homepage/docs to compress time-to-first-call. | A first call without a human in the loop — self-serve credentials, a free tier, or an API that needs none. |
| fail | Quickstart presentvia docs | 0/25 | No quickstart or getting-started page found at the conventional docs paths, so new developers and agents have no obvious first step. Investigated: docs 0%. Fix: Publish a single-page quickstart that goes from zero to a first successful API call. | A quickstart is the fastest path from landing page to first successful call. |
| na | Code samples in docs | —/18 | No surface produced evidence for this capability in this run. | Multi-language samples shorten time-to-first-call. |
| 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. |
| na | Changelog published | —/13 | No surface produced evidence for this capability in this run. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs0 pass3 warn1 fail66C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Docs reachable, not hard auth-gatedvia docs | 26.3/30 | Content negotiation partially supported: 0 correct type, 25 wrong type, 25 HTML only; 25 rate-limited (HTTP 429). Investigated: docs 88%. | 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 | 25.7/30 | No llms-full.txt was found at any candidate origin, so agents can't grab your full docs in one fetch. Investigated: docs 86%. Fix: Publish a concatenated, agent-readable copy of your documentation at /llms-full.txt on your docs site. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| warn | Crawlable / AEOvia wellknown | 6/12 | No sitemap found via robots.txt or /sitemap.xml on the docs host, so AI search engines have no crawl map for your docs. Investigated: wellknown 50%. Fix: Publish an XML sitemap and reference it from robots.txt. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| fail | Registry & SDK presencevia docs | 0/28 | Not indexed on Context7 — agents can't pull this API's docs on demand via Context7. Investigated: docs 0%, sdk 0%, cli 0%. Fix: Submit the docs to context7.com so coding agents can retrieve up-to-date docs on demand. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs0 pass1 warn1 fail64C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Agent-navigable, token-efficient docsvia docs | 17.6/22 | 25 of 50 sampled pages have content starting past 50% (worst 102%). Investigated: docs 80%. | 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/, so coding agents have no ready-made setup and usage instructions. Investigated: wellknown 0%. Fix: Publish an AGENTS.md with setup, auth, and usage instructions a coding agent can follow. | 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 | 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 | Docs structured data | —/8 | No surface produced evidence for this capability in this run. | 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 | Description consistency across surfaces | —/7 | Only 0 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 found for the org, so there's no runnable collection an agent can execute against. Investigated: platform 0%. Fix: Publish at least one public Postman workspace and link it from your developer portal so agents can use Run-in-Postman. | 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. |