Postmanpostman.com
Postman's developer experience and API usability are strong, giving partners a solid foundation for integration. However, the docs layer has a critical blind spot: no structured metadata (JSON-LD, OpenGraph, or equivalent) is present across any assessed pages, meaning answer engines and AI agents cannot cite or surface your documentation in automated discovery flows.
API DesignA clean, typed, well-governed API contract agents can reason about2 pass3 warn0 fail78B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Machine-readable, versioned contractvia spec | 22.5/25 | The API sets a version ("1.0.0") but exposes no versioning scheme in the URL, a header, or the media type, so an agent can't pin to a specific version. Investigated: spec 90%, docs 80%, cli 75%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia sdk | 17.4/25 | 262 of 1190 public signatures use loose types (anyTypeRatio=0.220). Investigated: sdk 70%, spec 48%. | 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%, sdk 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 spec | 10/10 | 100% of parameters and responses (542 of 542) include example values, grounding an agent in real payload shapes. Investigated: spec 100%, docs 100%, sdk 100%, cli 100%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
| warn | Auth declared & discoverablevia docs | 8.8/25 | The spec declares no authentication scheme, so an agent can't tell how to authenticate a request. Investigated: docs 35%, spec 18%, cli 0%, wellknown 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 examples4 pass1 warn0 fail99A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Self-service signup available at https://www.postman.com/signup, but no free tier or sandbox is documented, so an agent may hit a paywall before the first call. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Quickstart presentvia docs | 25/25 | Quickstart at https://learning.postman.com/docs/getting-started/quick-start/ has a runnable code sample in its plain-text .md variant (https://learning.postman.com/docs/getting-started/quick-start.md). Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Code samples in docsvia docs | 18/18 | Code samples appear on 2 of 17 sampled docs pages across 1 language(s), but broader multi-language coverage is missing. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| warn | Description completenessvia sdk | 14.4/15 | 406/424 operations carry a description. Investigated: sdk 96%, spec 5%. | Complete descriptions are the context humans and agents need to use endpoints. |
| pass | Changelog publishedvia spec | 13/13 | changelog is documented on the docs site at https://www.postman.com/release-notes/, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%. | A published changelog lets partners track changes without surprise. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs3 pass0 warn0 fail100A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | llms.txt present, valid & comprehensivevia docs | 30/30 | A full-corpus llms-full.txt is published at https://learning.postman.com/llms-full.txt, so agents can ingest all your docs in one fetch. Investigated: docs 100%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/learning_postman, 9228 snippets). Investigated: docs 100%, sdk 100%, mcp 100%, cli 0%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| pass | Crawlable / AEOvia wellknown | 12/12 | robots.txt lets all monitored AI crawlers reach the docs paths. Investigated: wellknown 100%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| na | Docs reachable, not hard auth-gated | —/30 | No surface produced evidence for this capability in this run. | Agents can only index and fetch docs they can reach — past auth gates and over correct HTTP semantics. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs2 pass2 warn1 fail79B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via sdk | 28/28 | Single base error "ThrowableError" with 211 subclasses. Investigated: sdk 100%, docs 15%, spec 8%, cli 0%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| pass | Operation purpose clarityvia sdk | 25/25 | Surface uses a single dominant casing convention (camelCase). Investigated: sdk 100%, spec 90%. | 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 instructions file (AGENTS.md)via sdk | 5/10 | No agents.md or skill.md context file found (nice-to-have for agent operation). Investigated: sdk 50%, cli 0%, 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. |
| warn | Description consistency across surfaces | 0.9/7 | Mean pairwise description similarity across 3 surfaces (spec, docs, sdk) is 5% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| fail | Docs structured datavia docs | 0/8 | No JSON-LD or OpenGraph/meta tags found across 3 assessed pages (3 JS-rendered), so answer engines have nothing to cite. 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 | Agent-navigable, token-efficient docs | —/22 | No surface produced evidence for this capability in this run. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them3 pass2 warn0 fail87A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia sdk | 27/27 | Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, spec 0%, docs 0%, cli 0%. | Documented idempotency lets agents retry safely. |
| warn | Pagination documented & consistentvia sdk | 20.1/22 | 21/23 list method(s) return an auto-paginating iterable. Investigated: sdk 91%, spec 0%, docs 0%. | Consistent, documented pagination lets agents traverse collections. |
| pass | Sandbox separationvia sdk | 20/20 | Sandbox environments are exposed (sandbox). Investigated: sdk 100%, spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
| pass | Runnable collection with test scriptsvia sdk | 9/9 | README is present and includes a runnable quickstart. Investigated: sdk 100%, platform 50%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| warn | Rate-limit signalingvia spec | 8.8/22 | No rate-limit response headers are documented, so an agent can't tell when it is approaching a limit and will get throttled. Investigated: spec 40%, docs 40%. | Machine-readable rate-limit headers let agents throttle adaptively. |
Resources Discovered
The public resources we found for Postman — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (9,228) |
|---|---|
| APIs analyzed | 10 — Reverse engineering an API, Postman Echo, Nanoleaf, Team Transfer, The Good Documentation Checklist, Copy a Workspace, Postman Assets Scaffolding, Import a HAR file, Intro to writing tests - with examples, jeopardy-mongo: building and testing APIs |