Sendcloudsendcloud.com
Sendcloud's API program shows real strength in documentation quality, schema design, and agent discoverability — partners and their agents can find and read the surface reliably. The two areas that need urgent attention are safe integration and operational reliability: there is no sandbox environment, no idempotency guidance, and no rate-limit signaling, meaning any agent-driven automation runs directly against production with no guardrails against duplicates or throttling.
API DesignA clean, typed, well-governed API contract agents can reason about4 pass1 warn0 fail93A+
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Machine-readable, versioned contractvia spec | 25/25 | The API declares version "3.0.0" and uses url-based versioning, so an agent can pin to a stable contract. Investigated: spec 100%, docs 100%. | A current OpenAPI version with a declared versioning scheme lets agents reason about the contract. |
| pass | Auth declared & discoverablevia spec | 25/25 | Authentication is required across the API (declared globally or on every operation), so an agent knows credentials are needed. Investigated: spec 100%, docs 100%, 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 | Schema coverage & depthvia spec | 17.4/25 | Only 83% of the 6 operations document both request and response schemas (target 95%+), so an agent can't reliably call the rest. Investigated: spec 69%, sdk 0%. Fix: Document request body and 2xx response schemas for every non-deprecated operation. | 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 0%. | 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 | Only 47% of parameters and responses (9 of 19) include example values, so an agent has little grounding in real payload shapes. Investigated: spec 100%, docs 0%, sdk 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 examples3 pass0 warn2 fail74B
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Self-service developer portalvia docs | 29/29 | Self-service signup available at https://account.sendcloud.com/signup/?_gl=1*5g7jxx*_gcl_au*MzgwMTE5MTQ5LjE3ODY1Mzg0NzY.*FPAU*MzgwMTE5MTQ5LjE3ODY1Mzg0NzY.*_ga*NTEzMjUyMzMyLjE3ODY1Mzg0NzY.*_ga_G20N49N1GG*czE3ODY1Mzg0NzYkbzEkZzAkdDE3ODY1Mzg0NzYkajYwJGwwJGgxNjM1OTY4Mzk0*_fplc*YnprQ2FaRDNsNEF0WnVLeXpGUGNXWDM1QkhrUzlzdFE5Wnh5UWM0SFdKd21IRzVndUUzcTZ6SWFrVCUyRml1QzAzRG95dUMlMkJkTU8lMkJqWWYya0M1OHA1akZPTU84WWVWMFdPSlNJRER6U3JOd1ptUVRic1VtRjdociUyQlBwams1NkElM0QlM0Q.*_ga_TBXEGHJ1GL*czE3ODY1Mzg0NzYkbzEkZzAkdDE3ODY1Mzg0NzYkajYwJGwwJGgw&ajs_aid=44c439a1-0a1a-4dd5-baab-6e4cd564f2bf, with a free tier or sandbox documented — an agent can onboard without contacting sales. 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 | Quickstart presentvia docs | 25/25 | Quickstart at https://sendcloud.dev/docs/getting-started/api-version-guide includes a runnable first-call code sample. Investigated: docs 100%. | A quickstart is the fastest path from landing page to first successful call. |
| pass | Description completenessvia spec | 15/15 | 100% of operations and parameters carry substantive descriptions (12 of 12 ops, 3 of 3 params), the main semantic cue an agent relies on. Investigated: spec 100%. | 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 20 sampled docs pages, so a coding agent gets no ready-to-use examples. Investigated: docs 0%. Fix: Add copy-pasteable code samples to API reference and quickstart pages. | Multi-language samples shorten time-to-first-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 | 28.6/30 | Same-origin links point to HTML and no markdown alternatives detected. Investigated: docs 95%. | A valid, comprehensive llms.txt is the machine-readable entry point for agents. |
| pass | Registry & SDK presencevia docs | 28/28 | Indexed on Context7 (websites/sendcloud_dev, 604 snippets). Investigated: docs 100%, sdk 88%, cli 0%, mcp 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%, 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 (6 of 6) have both a clear summary and a descriptive name, so an agent can pick the right endpoint. 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. |
| warn | Agent-navigable, token-efficient docsvia docs | 21.7/22 | 3 of 50 sampled pages convert to over 100K chars (max 814K HTML → 282K markdown (85% boilerplate)). 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%, 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.7/7 | Mean pairwise description similarity across 3 surfaces (spec, docs, sdk) is 3% (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 them1 pass1 warn3 fail48F
| Signal | Points | Findings | Rationale | |
|---|---|---|---|---|
| pass | Pagination documented & consistentvia docs | 22/22 | Pagination parameters are present on the 2 list endpoint(s), so an agent can page through results. Investigated: docs 100%, spec 88%. | 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%, sdk 0%. Fix: Add pm.test() assertions so the collection can be used as an agent-runnable test suite. | A public, maintained collection with assertions is runnable truth agents validate against. |
| fail | Idempotency documentedvia spec | 0/27 | Only 0% of mutating operations (0 of 3) document idempotency, so an agent's retries can create duplicate writes. Investigated: spec 0%, docs 0%. Fix: Agents retry on failure; without idempotency, retries create duplicates. Document Idempotency-Key on every POST/PUT/PATCH/DELETE. | Documented idempotency lets agents retry safely. |
| fail | Rate-limit signalingvia spec | 0/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 0%, docs 0%. Fix: Add x-ratelimit-* response headers and document retry-after semantics. | Machine-readable rate-limit headers let agents throttle adaptively. |
| fail | Sandbox separationvia spec | 0/20 | None of the 1 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%. Fix: Add a sandbox server in spec.servers[] with visually distinguishable test credentials. | An isolated environment lets agents exercise destructive operations safely. |
Resources Discovered
The public resources we found for Sendcloud — the evidence behind the score. All discovered from public sources; nothing here requires access to your systems.
| Agent hints | Context7 (604) |
|---|---|
| APIs analyzed | 7 — Event Subscriptions API, Shipments, Parcels, Returns, Orders, Dynamic Checkout [BETA], Webhooks |