# Goshippo — API Agent Score

> Score: 81/100 (Grade: A) | Domain: goshippo.com | Rubric: 1.0.0 | Checked: July 24, 2026

Goshippo scored 81/100 (A), classified "ai-ready".

[View full report](https://www.postman.com/ai/ai-ready-apis/company/goshippo)
[All organizations](https://www.postman.com/ai/ai-ready-apis/llms.txt)

## Summary

- Overall: 81/100 (A)
- Classification: ai-ready

## Category Scores

- API Design: 84/100 (A)
- Developer Experience: 66/100 (C)
- Agent Discovery: 98/100 (A+)
- Agent Understanding: 83/100 (A)
- Agent Usability: 71/100 (B)

## Check Results

### API Design

- [pass] Machine-readable, versioned contract — API versioning documented in the docs site at https://docs.goshippo.com/api-concepts/api-change-log. Investigated: spec 100%, docs 100%.
- [pass] Auth declared & discoverable — Authentication required (global or on every operation). Investigated: spec 100%, docs 100%.
- [warn] Schema coverage & depth — Only 50% of operations have documented schemas. Investigated: spec 67%.
- [pass] Security & governance hygiene — No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 0%.
- [fail] Example coverage — 43% example coverage. Investigated: spec 0%, docs 0%.

### Developer Experience

- [pass] Self-service developer portal — Signup page at https://apps.goshippo.com/join? (CSR-rendered — body classifier inconclusive); free tier / sandbox documented in pricing/docs. Investigated: docs 100%.
- [pass] Description completeness — 77% description completeness (target 90%+). Investigated: spec 100%.
- [pass] Changelog published — changelog documented in the docs site at https://docs.goshippo.com/api-concepts/api-change-log. Investigated: spec 100%, docs 100%, sdk 100%.
- [fail] Quickstart present — No quickstart/getting-started page found at the conventional paths. Investigated: docs 0%.
- [fail] Code samples in docs — No detectable code samples across 20 sampled docs pages. Investigated: docs 0%.

### Agent Discovery

- [pass] Docs reachable, not hard auth-gated — All 50 sampled pages are publicly accessible. Investigated: docs 100%.
- [warn] llms.txt present, valid & comprehensive — llms.txt directive found in HTML of 49 of 50 sampled pages (1 missing). Investigated: docs 94%.
- [pass] Registry & SDK presence — Indexed on Context7 (websites/goshippo, 6369 snippets). Investigated: docs 100%, sdk 100%, cli 0%.
- [pass] Crawlable / AEO — Docs paths crawlable by all monitored AI agents. Investigated: wellknown 100%.

### Agent Understanding

- [pass] Machine-readable errors (RFC 9457) — Only 3 distinct 4xx/5xx codes documented (plus 0 "default" catch-all responses). Investigated: docs 100%, spec 50%.
- [pass] Operation purpose clarity — 100% of operations have a clear summary + operationId an agent can select on. Investigated: spec 100%.
- [warn] Agent-navigable, token-efficient docs — 2 of 49 pages have substantive content differences between markdown and HTML (avg 5% missing). Investigated: docs 61%.
- [pass] Docs structured data — JSON-LD Article markup on 20/20 assessed pages (100%) with dateModified present. Investigated: docs 100%.
- [warn] Description consistency across surfaces — Mean pairwise description similarity across 2 surfaces (spec, docs) is 31% (threshold 35% for full credit).
- [fail] Agent instructions file (AGENTS.md) — No AGENTS.md at the site root or /.well-known/. Investigated: wellknown 0%.

### Agent Usability

- [pass] Rate-limit signaling — rate-limit behavior documented in the docs site at https://docs.goshippo.com/api-concepts/rate-limits. Investigated: spec 100%, docs 100%.
- [pass] Pagination documented & consistent — Pagination params detected on 1 list endpoint(s). Investigated: spec 100%, docs 100%.
- [pass] Sandbox separation — sandbox documented in the docs site at https://docs.goshippo.com/guides/testing. Investigated: spec 100%, docs 100%.
- [fail] Idempotency documented — 0% of mutating operations document idempotency. Investigated: spec 0%, docs 0%.
- [fail] Runnable collection with test scripts — No public Postman workspace discovered for the org. Investigated: platform 0%.

## Executive Summary

Goshippo's API program shows strong discoverability and doc parseability, but partners and their AI agents face two compounding blockers: there are no concrete examples woven through the reference, and no runnable collection or agent instruction file to ground integrations. Together these gaps mean partners and their coding agents must guess at real request shapes — slowing every integration and raising support load. The highest-leverage investments are adding rich examples and a runnable collection to unblock self-serve onboarding, followed by closing the agent-context and idempotency documentation gaps to make the API safe for automated workflows.