# WorkOS — API Agent Score

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

WorkOS scored 85/100 (A), classified "ai-ready".

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

## Summary

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

## Category Scores

- API Design: 82/100 (A)
- Developer Experience: 79/100 (B)
- Agent Discovery: 86/100 (A)
- Agent Understanding: 81/100 (A)
- Agent Usability: 96/100 (A+)

## Check Results

### API Design

- [pass] Schema coverage & depth — .d.ts present on disk but not declared in package.json. Investigated: sdk 100%, spec 67%.
- [pass] Auth declared & discoverable — Authentication required (global or on every operation). Investigated: spec 100%, docs 100%.
- [warn] Machine-readable, versioned contract — info.version="1.0" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 75%, docs 50%.
- [pass] Example coverage — Code samples in 9 language(s) across docs (top: shell, python, ruby); 13/19 pages have ≥ 2 languages on the same page. Investigated: docs 100%, sdk 100%, spec 0%.
- [fail] Security & governance hygiene — 11 credential-shaped strings detected in spec: github-token (×8), bearer-jwt (×3). Investigated: spec 0%, wellknown 0%.

### Developer Experience

- [pass] Self-service developer portal — Self-service signup at https://signin.workos.com/sign-up?client_id=project_01DG5TGK363GRVXP3ZS40WNGEZ&redirect_uri=https%3A%2F%2Fapi.workos.com%2Fx%2Fauth%2Fauthkit%2Fcallback&state=eyJub25jZSI6InJpdUx2NlZBcEo5OG91U1ozbW1aR25lU3FWUTc4NXBkSEEyQVFHWmhIc3c9IiwicmVkaXJlY3QiOiIvIn0%3D&authorization_session_id=01KY9DKEE7KAJK8BCYSPCJC708; no free tier or sandbox language detected. Investigated: docs 100%.
- [pass] Code samples in docs — Code samples in 9 language(s) across docs (top: shell, python, ruby); 13/19 pages have ≥ 2 languages on the same page. Investigated: docs 100%.
- [pass] Description completeness — 94% of operations + parameters have substantive descriptions. Investigated: spec 100%.
- [pass] Changelog published — changelog documented in the docs site at https://workos.com/changelog. Investigated: spec 100%, docs 100%, sdk 100%.
- [fail] Quickstart present — No quickstart/getting-started page found at the conventional paths. Investigated: docs 0%.

### Agent Discovery

- [pass] Registry & SDK presence — Indexed on Context7 (websites/workos, 8062 snippets). Investigated: docs 100%, mcp 100%, sdk 50%, cli 50%, wellknown 0%.
- [warn] llms.txt present, valid & comprehensive — No llms.txt directive found in HTML of any of 50 sampled pages. Investigated: docs 81%, sdk 0%.
- [warn] Docs reachable, not hard auth-gated — 22 JavaScript redirect(s) detected across 50 sampled pages. Investigated: docs 75%.
- [warn] Crawlable / AEO — Sitemap present (3 entries) but carries no lastmod values. Investigated: wellknown 75%.

### Agent Understanding

- [pass] Machine-readable errors (RFC 9457) — 9 distinct 4xx/5xx response codes documented. Investigated: docs 100%, spec 50%.
- [pass] Operation purpose clarity — 99% of operations have a clear summary + operationId an agent can select on. Investigated: spec 100%.
- [warn] Agent-navigable, token-efficient docs — 3 of 50 pages have substantive content differences between markdown and HTML (avg 5% missing). Investigated: docs 70%.
- [pass] Docs structured data — JSON-LD Article markup on 4/7 assessed pages (57%) with dateModified present. Investigated: docs 100%.
- [warn] Description consistency across surfaces — Mean pairwise description similarity across 2 surfaces (docs, sdk) is 8% (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] Idempotency documented — Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, spec 0%, docs 0%.
- [pass] Rate-limit signaling — rate-limit behavior documented in the docs site at https://workos.com/docs/rate-limits. Investigated: spec 100%, docs 100%.
- [pass] Pagination documented & consistent — Pagination params detected on 42 list endpoint(s). Investigated: spec 100%, docs 100%.
- [pass] Sandbox separation — Sandbox server declared but no distinguishable test credentials in scheme descriptions. Investigated: spec 100%, docs 100%, sdk 100%.
- [warn] Runnable collection with test scripts — No test scripts found in the workspace's collections. Investigated: platform 50%.

## Executive Summary

WorkOS has a strong foundation across API design, discoverability, and documentation parseability — partners and agents can find and read your APIs with minimal friction. The two areas that need the most attention are agent-readiness (specifically, giving AI agents the structured instructions and runnable context they need to integrate without guessing) and developer onboarding speed (partners currently lack a self-serve quickstart path to a first successful call). Prioritizing these two areas will meaningfully reduce partner time-to-integration and make WorkOS APIs first-class citizens in AI-assisted development workflows.