Getpostmangetpostman.com
Getpostman's API program shows strong agent discoverability but has two critical gaps that block safe, autonomous partner integration: there is no sandbox environment for agents to test against without hitting production, and there is no agent-facing context artifact to guide AI agents through the API's capabilities and conventions. Closing these two gaps — safe integration first, then agent context and code samples — will meaningfully accelerate partner onboarding and reduce integration risk for both human developers and AI agents.
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 | 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%. | 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. |
| warn | Schema coverage & depthvia spec | 12.5/25 | Only 2% of the 62 operations document request and response schemas, so an agent can't do function-calling against most endpoints. Investigated: spec 50%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| warn | Auth declared & discoverablevia cli | 12.5/25 | help mentions auth but not the exact env var. Investigated: cli 50%, docs 45%, spec 23%, wellknown 0%. | Agents can only authenticate when auth is declared, scoped, and discoverable. |
| pass | Example coveragevia spec | 10/10 | 100% of parameters and responses (1403 of 1403) include example values, grounding an agent in real payload shapes. Investigated: spec 100%, cli 100%, docs 0%. | 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 fail66C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Self-service signup available at https://www.postman.com/signup, with a free tier or sandbox documented — an agent can onboard without contacting sales. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Changelog publishedvia spec | 13/13 | changelog is documented on the docs site at https://www.postman.com/release-notes/postman-app/, even though it isn't declared in the API spec. Investigated: spec 100%, docs 100%. | A published changelog lets partners track changes without surprise. |
| warn | Quickstart presentvia docs | 12.5/25 | Quickstart page is reachable at https://learning.postman.com/docs/getting-started/overview/ (3 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%. | A quickstart is the fastest path from landing page to first successful call. |
| warn | Description completenessvia spec | 2.3/15 | Only 33% of operations and parameters have descriptions (41 of 62 ops, 0 of 541 params), leaving an agent to guess what most endpoints do. Investigated: spec 15%. | Complete descriptions are the context humans and agents need to use endpoints. |
| fail | Code samples in docsvia docs | 0/18 | No code samples detected across 3 sampled docs pages, so a coding agent gets no ready-to-use examples. 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 docs3 pass1 warn0 fail93A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Docs reachable, not hard auth-gatedvia docs | 30/30 | All 1 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. |
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/documenter_getpostman_view_7907941_s1a32n38, 254 snippets). Investigated: docs 100%, sdk 0%, cli 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | llms.txt present, valid & comprehensivevia docs | 22.5/30 | llms.txt covers 0/1 sitemap doc pages (0%); 1 missing. Investigated: docs 75%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| 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 docs1 pass4 warn1 fail78B
| 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%, spec 58%, cli 0%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| warn | Operation purpose clarityvia spec | 22.5/25 | Only 78% of operations (21 of 27) have both a clear summary and a descriptive name (target 90%+), so an agent may pick the wrong endpoint for the rest. Investigated: 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 | 18.7/22 | 3 of 4 endpoints have aggressive caching or missing cache headers. Investigated: docs 85%. | 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 markup on only 2 of 2 assessed pages, and 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 | 0.1/7 | Mean pairwise description similarity across 2 surfaces (spec, docs) is 1% (threshold 35% for full credit). | Every surface tells the same story about what the product is. |
| fail | Agent instructions file (AGENTS.md)via cli | 0/10 | no agent-facing context artifact. Investigated: 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. |
Agent UsabilityAgents have the context to use your APIs reliably, not just find them0 pass4 warn1 fail48F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| 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. |
| warn | Idempotency documentedvia cli | 6.8/27 | no `--dry-run` flag found. Investigated: cli 25%, spec 0%, docs 0%. | Documented idempotency lets agents retry safely. |
| warn | Pagination documented & consistentvia spec | 5.5/22 | The 2 list endpoint(s) expose no pagination parameters, forcing an agent into all-or-nothing reads. Investigated: spec 25%, docs 25%. | Consistent, documented pagination lets agents traverse collections. |
| warn | Runnable collection with test scriptsvia platform | 4.5/9 | No test scripts found in the workspace's public collections, so an agent can't use them to verify API behavior. Investigated: platform 50%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| fail | Sandbox separationvia spec | 0/20 | None of the 2 declared server(s) is a sandbox/test host, and no test-key prefixes are documented, so agents can only hit production. Investigated: spec 0%, docs 0%. | An isolated environment lets agents exercise destructive operations safely. |
Resources Discovered
The public resources we found for Getpostman — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (254) |
|---|---|
| APIs analyzed | 10 — Postman API, 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 |