# Zip — API Agent Score

> Score: 72/100 (Grade: B) | Domain: zip.co | Rubric: 1.0.0 | Checked: September 18, 2026

Zip scored 72/100 (B), classified "partially-ready".

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

## Summary

- Overall: 72/100 (B)
- Classification: partially-ready

## Category Scores

- API Design: 89/100 (A)
- Developer Experience: 45/100 (F)
- Agent Discovery: 73/100 (B)
- Agent Understanding: 88/100 (A)
- Agent Usability: 65/100 (C)

## Check Results

### API Design

- [pass] Machine-readable, versioned contract — The API declares version "1.0" and uses url-based versioning, so an agent can pin to a stable contract. Investigated: spec 100%, docs 100%.
- [pass] Schema coverage & depth — package.json "types" → types.d.ts. Investigated: sdk 100%, spec 67%.
- [pass] Security & governance hygiene — No credential-shaped strings detected in spec. Investigated: spec 100%, sdk 100%, wellknown 0%.
- [warn] Auth declared & discoverable — Authentication is declared on only 1 of 75 operations, so an agent can't tell which endpoints need credentials. Investigated: docs 50%, spec 25%, wellknown 0%.
- [pass] Example coverage — README is present and includes a runnable quickstart. Investigated: sdk 100%, spec 0%.

### Developer Experience

- [pass] Description completeness — Only 74% of operations and parameters have substantive descriptions (52 of 75 ops, 282 of 361 params; target 90%+). Investigated: spec 100%.
- [fail] Self-service developer portal — No self-service signup detected — no signup link on the homepage or docs, and no conventional signup path (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free, /join, /create-account, /account/signup, /auth/signup, /users/sign_up) resolved — so an agent can't onboard on its own. Investigated: docs 0%.
- [fail] Quickstart present — No quickstart or getting-started page found at the conventional docs paths, so new developers and agents have no obvious first step. Investigated: docs 0%.
- [fail] Changelog published — 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%.
- [skip] Code samples in docs — No surface produced evidence for this capability in this run.

### Agent Discovery

- [pass] Registry & SDK presence — Indexed on Context7 (zip-rs/zip2, 574 snippets). Investigated: docs 100%, sdk 67%, cli 0%, mcp 0%, wellknown 0%.
- [warn] llms.txt present, valid & comprehensive — Could not test any pages; 1 failed to fetch. Investigated: docs 60%, sdk 0%.
- [warn] Docs reachable, not hard auth-gated — 1 JavaScript redirect(s) detected across 1 pages. Investigated: docs 50%.
- [warn] Crawlable / AEO — No sitemap found via robots.txt or /sitemap.xml on the docs host, so AI search engines have no crawl map for your docs. Investigated: wellknown 50%.

### Agent Understanding

- [pass] Machine-readable errors (RFC 9457) — Documents 9 distinct 4xx/5xx error response codes, so an agent can branch on specific failures instead of guessing. Investigated: docs 100%, spec 50%.
- [pass] Operation purpose clarity — 91% of operations (68 of 75) have both a clear summary and a descriptive name, so an agent can pick the right endpoint. Investigated: spec 100%, sdk 100%.
- [warn] Agent-navigable, token-efficient docs — No pages support .md URLs (0/1 tested). Investigated: docs 69%.
- [warn] Agent instructions file (AGENTS.md) — No agents.md or skill.md context file found (nice-to-have for agent operation). Investigated: sdk 50%, wellknown 0%.
- [skip] Docs structured data — No surface produced evidence for this capability in this run.
- [skip] Description consistency across surfaces — Only 1 surface description(s) with ≥6 tokens available; need at least 2 to compare.

### Agent Usability

- [pass] Idempotency documented — Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, spec 0%, docs 0%.
- [pass] Sandbox separation — Spec declares a sandbox server but no distinguishable test credentials, so agents can't tell test calls from live ones. Investigated: spec 100%, docs 100%, sdk 50%.
- [pass] Runnable collection with test scripts — README is present and includes a runnable quickstart. Investigated: sdk 100%, platform 0%.
- [fail] Rate-limit signaling — 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%.
- [fail] Pagination documented & consistent — The 1 list endpoint(s) expose no pagination parameters, forcing an agent into all-or-nothing reads. Investigated: spec 0%, docs 0%.

## Executive Summary

Zip's API design and agent understanding are strong, giving partners a solid contract to build against. However, the partner program has two critical gaps that will stall adoption: there is no self-service onboarding path or quickstart, meaning new partners cannot get started without a sales conversation, and there is no published changelog, leaving partners and their agents blind to breaking changes. Fixing these onboarding and change-communication gaps is the highest-leverage investment, followed by closing operational reliability gaps — missing rate-limit signaling and pagination — that will cause agent integrations to fail unpredictably in production.