PayPalpaypal.com
PayPal's API program shows strong fundamentals in contract design, schema quality, and auth — areas partners and agents can build against with confidence. The most urgent gaps are in operational reliability and agent discoverability: agents attempting to integrate today will find no idempotency guidance, no rate-limit signaling, and no machine-readable front door to navigate the API surface.
API DesignA clean, typed, well-governed API contract agents can reason about1 pass4 warn0 fail77B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| warn | Schema coverage & depthvia sdk | 23/25 | 18/19 (95%) public params are fully typed (no any/**kwargs). Analyzer reports not all methods have a derivable input schema. Investigated: sdk 92%, spec 58%. | Typed, complete request/response schemas are what make agent function-calling possible. |
| warn | Machine-readable, versioned contractvia spec | 18.8/25 | info.version="1.0.0" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 75%, docs 50%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| warn | Security & governance hygienevia spec | 13.5/15 | 3 credential-shaped strings detected in spec: bearer-jwt (×3). Investigated: spec 90%, wellknown 50%. | 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 | No parameters or responses available to score example coverage. Investigated: spec 100%, sdk 100%. | Examples carry shape semantics schemas under-specify — for humans and agents alike. |
| warn | Auth declared & discoverablevia docs | 7.5/25 | No securitySchemes declared. Investigated: docs 30%, spec 15%. | 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 pass0 warn1 fail81A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Self-service signup at https://www.paypal.com/console/signup; no free tier or sandbox language detected. Investigated: docs 100%. | Self-serve key/account creation is the fast first call for partners, with no sales gate. |
| pass | Description completenessvia spec | 15/15 | 50% description completeness. Investigated: spec 100%, sdk 90%. | Complete descriptions are the context humans and agents need to use endpoints. |
| fail | Changelog publishedvia spec | 0/13 | No changelog URL or mention found in spec metadata. Investigated: spec 0%, docs 0%. | A published changelog lets partners track changes without surprise. |
| na | Quickstart present | —/25 | No surface produced evidence for this capability in this run. | 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. |
Agent DiscoveryPartners and their agents can find your APIs — llms.txt, registries, crawlable and reachable docs1 pass1 warn1 fail60C
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (paypal/paypal-js, 238 snippets). Investigated: docs 100%, sdk 100%, mcp 50%, cli 0%, wellknown 0%. | Listing in MCP registries and publishing SDKs puts the API where agents and their tooling look. |
| warn | Crawlable / AEOvia wellknown | 6/12 | Sitemap present (1213 entries) but carries no lastmod values. Investigated: wellknown 50%. | Bots allowed plus a fresh sitemap make docs findable by agent crawlers. |
| fail | llms.txt present, valid & comprehensivevia docs | 0/30 | No /llms-full.txt found at the candidate origins. Investigated: docs 0%, sdk 0%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| 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 pass0 warn1 fail86A
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable errors (RFC 9457)via docs | 28/28 | No 4xx/5xx response codes (or default error response) documented anywhere in the spec. Investigated: docs 100%, sdk 100%, spec 50%. | RFC 9457 problem details and a documented error-code inventory let agents parse failures without burning tokens. |
| pass | Operation purpose clarityvia spec | 25/25 | 100% of operations have a clear summary + operationId an agent can select on. Investigated: spec 100%. | Agents select the right endpoint from its summary + operationId; clear, named operations make tool-selection reliable — the strongest driver of correct tool choice. |
| 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. |
| 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. |
| 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 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 them2 pass1 warn2 fail59D
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Pagination documented & consistentvia spec | 22/22 | page_size pagination detected (good for agents). Investigated: spec 100%, docs 100%. | Consistent, documented pagination lets agents traverse collections. |
| pass | Sandbox separationvia spec | 20/20 | Sandbox server declared but no distinguishable test credentials in scheme descriptions. Investigated: spec 100%, docs 100%, sdk 100%. | An isolated environment lets agents exercise destructive operations safely. |
| warn | Runnable collection with test scriptsvia platform | 4.5/9 | No test scripts found in the workspace's collections. Investigated: platform 50%. | A public, maintained collection with assertions is runnable truth agents validate against. |
| fail | Idempotency documentedvia spec | 0/27 | 0% of mutating operations document idempotency. Investigated: spec 0%, docs 0%, sdk 0%. | Documented idempotency lets agents retry safely. |
| fail | Rate-limit signalingvia spec | 0/22 | No rate-limit response headers documented. Investigated: spec 0%, docs 0%. | Machine-readable rate-limit headers let agents throttle adaptively. |
Resources Discovered
The public resources we found for PayPal — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (238) |
|---|---|
| APIs analyzed | 10 — PayPal APIs, Invoicing, Subscriptions, Disputes, PayPal Checkout Flows, Webhooks Management, Orders, Sam Gabbard, Payments, Payment Method Tokens |