Postmanpostman.com
Your API program performs strongly across design, discoverability, and agent readiness — partners and their agents can find, parse, and act on your APIs with high confidence. The one meaningful gap is in change communication: without a published changelog, partners and AI agents have no reliable signal when something shifts, leaving them exposed to silent breaking changes.
API DesignA clean, typed, well-governed API contract agents can reason about3 pass2 warn0 fail95A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Auth declared & discoverablevia docs | 25/25 | authentication is documented on the docs site at https://learning.postman.com/docs/reference/postman-api/authentication/, even though it isn't declared in the API spec. Investigated: docs 100%, spec 50%, cli 50%, wellknown 0%. | Agents can only call an API when they can determine its auth posture — a declared scheme, or an explicit statement that none is required. |
| warn | Machine-readable, versioned contractvia spec | 23.1/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 93%, docs 85%, cli 75%. Fix: Pick a versioning scheme (URL path /v1/, Accept: application/vnd.x+json, or a version header) and apply it consistently. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Schema coverage & depthvia sdk | 21/25 | 269 of 1217 public signatures use loose types (anyTypeRatio=0.221). Investigated: sdk 84%, spec 58%. Fix: Replace any/unknown/object/dict/**kwargs in public params and return types with named or primitive types. | 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 (1510 of 1511) 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. |
Developer ExperienceThe context both developers and agents need to integrate fast — onboarding, code samples, complete descriptions and worked examples2 pass2 warn1 fail78B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Signup page found at https://www.postman.com/signup, but no free tier or sandbox is documented in docs/pricing, so an agent may hit a paywall. Investigated: docs 100%. | A first call without a human in the loop — self-serve credentials, a free tier, or an API that needs none. |
| pass | Code samples in docsvia docs | 18/18 | Docs show code samples in 9 language(s) (top: python, javascript, go), and 20 of 20 sampled pages offer ≥ 2 languages side by side. Investigated: docs 100%. | Multi-language samples shorten time-to-first-call. |
| warn | Description completenessvia sdk | 14.4/15 | 416/434 operations carry a description. Investigated: sdk 96%, spec 15%. | Complete descriptions are the context humans and agents need to use endpoints. |
| warn | Quickstart presentvia docs | 12.5/25 | Quickstart page is reachable at https://learning.postman.com/docs/getting-started/overview/ (2 variants scanned) but has no runnable code sample in its HTML or .md variant, so there's nothing to copy and run. Investigated: docs 50%. Fix: Add a copy-pasteable curl or SDK call, with the expected response, to the quickstart page (or its .md variant). | A quickstart is the fastest path from landing page to first successful call. |
| fail | Changelog publishedvia spec | 0/13 | No changelog link or mention appears in the spec, so an agent can't tell what changed before something breaks. Investigated: spec 0%, docs 0%. Fix: Publish a structured changelog (e.g., /changelog.json or releases.atom) and reference it in info or externalDocs. | 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 pass1 warn0 fail99A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Docs reachable, not hard auth-gatedvia docs | 30/30 | All 50 sampled pages are publicly accessible. Investigated: docs 100%. | 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 | 29.1/30 | llms.txt contains parseable links but doesn't fully follow the proposed structure: https://learning.postman.com/api-docs/api-reference/llms.txt: No H1 heading found. Investigated: docs 97%, 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, 19280 snippets). Investigated: docs 100%, mcp 100%, sdk 83%, 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. |
Agent UnderstandingAgents can correctly interpret your APIs — machine-readable errors, consistent descriptions, structured data, parseable docs3 pass3 warn0 fail90A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | No error responses (4xx/5xx or a catch-all default) are documented anywhere in the spec, so an agent can't anticipate or handle failures. Investigated: docs 100%, sdk 100%, spec 50%, 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-navigable, token-efficient docsvia docs | 21.7/22 | 2 of 50 pages exceed 100K chars (max 473K). Investigated: docs 99%. | Server-rendered, clean, small-footprint docs are what an agent can cheaply fetch and parse correctly. |
| pass | Docs structured datavia docs | 8/8 | Machine-readable JSON-LD Article markup on 20 of 20 assessed pages (100%), with dateModified present. Investigated: docs 100%. | 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 | 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%. Fix: Add an agents.md or skill.md describing how an agent should use this SDK (auth setup, key operations, gotchas). | 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.5/7 | Mean pairwise description similarity across 3 surfaces (spec, docs, sdk) is 2% (threshold 35% for full credit). Fix: Align the API description across spec, docs, and SDK so an agent reading any one surface gets the same story. | Every surface tells the same story about what the product is. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them4 pass1 warn0 fail99A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Idempotency documentedvia sdk | 27/27 | Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, cli 25%, spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| pass | Rate-limit signalingvia spec | 22/22 | rate-limit behavior is documented on the docs site at https://learning.postman.com/docs/reference/postman-api/postman-api-rate-limits/, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%. | Machine-readable rate-limit headers let agents throttle adaptively. |
| warn | Pagination documented & consistentvia sdk | 21/22 | 21/22 list method(s) return an auto-paginating iterable. Investigated: sdk 95%, spec 25%, docs 25%. | 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. |
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 (19,280) |
|---|---|
| APIs analyzed | 10 — Postman API (DEPRECATED), 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 |