# Typesense — API Agent Score

> Score: 72/100 (Grade: B) | Domain: typesense.org | Rubric: 1.0.0 | Checked: July 24, 2026

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

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

## Summary

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

## Category Scores

- API Design: 94/100 (A+)
- Developer Experience: 52/100 (D)
- Agent Discovery: 83/100 (A)
- Agent Understanding: 80/100 (A)
- Agent Usability: 54/100 (D)

## Check Results

### API Design

- [pass] Auth declared & discoverable — Authentication required (global or on every operation). Investigated: spec 100%, docs 100%.
- [warn] Schema coverage & depth — 268/268 (100%) public params are fully typed (no any/**kwargs). Analyzer confirms all methods have a derivable input schema. Investigated: sdk 100%, spec 67%.
- [warn] Machine-readable, versioned contract — info.version="30.0" set but no versioning scheme (URL / header / media type) detected. Investigated: spec 75%, docs 50%.
- [pass] Security & governance hygiene — No credential-shaped strings detected in spec. Investigated: spec 100%, wellknown 0%.
- [pass] Example coverage — README is present and includes a runnable quickstart. Investigated: sdk 100%, spec 0%.

### Developer Experience

- [pass] Description completeness — 87% description completeness (target 90%+). Investigated: spec 100%, sdk 71%.
- [pass] Changelog published — Newest official SDK activity 0 day(s) ago. Investigated: sdk 100%, spec 0%, docs 0%.
- [fail] Self-service developer portal — No signup page detected across conventional paths (/signup, /sign-up, /register, /get-started, /console/signup, /dashboard/signup, /try, /try-free, /free, /free-trial, /start, /start-free). Investigated: docs 0%.
- [fail] Quickstart present — No quickstart/getting-started page found at the conventional paths. Investigated: 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 (typesense/typesense-website, 2841 snippets). Investigated: docs 100%, sdk 67%, cli 0%.
- [warn] Docs reachable, not hard auth-gated — Server ignores Accept: text/markdown header (0/50 sampled pages return markdown). Investigated: docs 75%.
- [warn] llms.txt present, valid & comprehensive — Could not test any pages; 50 failed to fetch. Investigated: docs 67%, sdk 0%.
- [warn] Crawlable / AEO — Sitemap lastmod coverage 100% or newest entry older than 90 days. Investigated: wellknown 75%.

### Agent Understanding

- [pass] Machine-readable errors (RFC 9457) — Only 3 distinct 4xx/5xx codes documented (plus 0 "default" catch-all responses). Investigated: docs 100%, sdk 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 — 50 of 50 sampled pages appear to be client-side rendered SPA shells (__nuxt detected); agents using HTTP fetches will see no content. Investigated: docs 70%.
- [warn] Description consistency across surfaces — Mean pairwise description similarity across 2 surfaces (spec, sdk) is 10% (threshold 35% for full credit).
- [fail] Agent instructions file (AGENTS.md) — No AGENTS.md at the site root or /.well-known/. Investigated: wellknown 0%.
- [skip] Docs structured data — No surface produced evidence for this capability in this run.

### Agent Usability

- [pass] Idempotency documented — Built-in retry machinery is present (grep-derived). Investigated: sdk 100%, spec 0%, docs 0%.
- [warn] Sandbox separation — No test-mode flag or sandbox environment is exposed. Investigated: sdk 50%, spec 0%, docs 0%.
- [fail] Rate-limit signaling — No rate-limit response headers documented. Investigated: spec 0%, docs 0%.
- [fail] Pagination documented & consistent — 9 list endpoint(s) exist but no pagination params found. Investigated: spec 0%, docs 0%.
- [fail] Runnable collection with test scripts — No public Postman workspace discovered for the org. Investigated: platform 0%.

## Executive Summary

Typesense's API design and agent discoverability are strong — partners and agents can find and read the contract without friction. The two areas holding back the partner program are onboarding and agent usability: there is no self-service portal or guided quickstart to get a partner to a first successful call independently, and there are no runnable collections, rate-limit signals, or consistent pagination patterns for agents to build reliable workflows against. Closing these gaps will convert partner interest into active integrations faster and reduce the support burden that comes with underdocumented operational behavior.