# GitBook — API Agent Score

> Score: 81/100 (Grade: A) | Domain: gitbook.com | Rubric: 1.0.0 | Checked: October 27, 2026

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

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

## Summary

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

## Category Scores

- API Design: 100/100 (A+)
- Developer Experience: 100/100 (A+)
- Agent Discovery: 91/100 (A+)
- Agent Understanding: 78/100 (B)
- Agent Usability: 52/100 (D)

## Check Results

### API Design

- [pass] Schema coverage & depth — .d.ts present on disk but not declared in package.json. Investigated: sdk 100%.
- [pass] Security & governance hygiene — Code is formatter-clean with zero linter errors and zero style warnings. Investigated: sdk 100%, wellknown 0%.
- [pass] Example coverage — Docs show code samples in 5 language(s) (top: javascript, http, python), and 2 of 20 sampled pages offer ≥ 2 languages side by side. Investigated: docs 100%, sdk 100%.
- [skip] Machine-readable, versioned contract — No surface produced evidence for this capability in this run.
- [skip] Auth declared & discoverable — No surface produced evidence for this capability in this run.

### Developer Experience

- [pass] Self-service developer portal — Signup page at https://app.gitbook.com/join?utm_content=header_sign_up&utm_source=gitbook_docs (client-rendered, so its contents couldn't be classified); free tier or sandbox is documented in pricing/docs. Investigated: docs 100%.
- [pass] Quickstart present — Quickstart at https://gitbook.com/docs/getting-started/quickstart has a runnable code sample in its plain-text .md variant (https://gitbook.com/docs/getting-started/quickstart.md). Investigated: docs 100%.
- [pass] Code samples in docs — Docs show code samples in 5 language(s) (top: javascript, http, python), and 2 of 20 sampled pages offer ≥ 2 languages side by side. Investigated: docs 100%.
- [skip] Description completeness — No surface produced evidence for this capability in this run.
- [skip] Changelog published — No surface produced evidence for this capability in this run.

### Agent Discovery

- [pass] Docs reachable, not hard auth-gated — All 50 sampled pages are publicly accessible. Investigated: docs 100%.
- [pass] Registry & SDK presence — Indexed on Context7 (llmstxt/gitbook_llms_txt, 8070 snippets). Investigated: docs 100%, cli 100%, sdk 33%, mcp 0%, wellknown 0%.
- [warn] llms.txt present, valid & comprehensive — llms.txt covers 719/1286 sitemap doc pages (56%); 567 missing — Missing: https://gitbook.com/docs, https://gitbook.com/docs/documentation/fr, https://gitbook.com/docs/documentation/fr/getting-started/quickstart, https://gitbook.com/docs/documentation/fr/getting-started/llm-ready-docs, https://gitbook.com/docs/documentation/fr/getting-started/import (and 45 more). Investigated: docs 76%, sdk 0%.
- [warn] Crawlable / AEO — Sitemap has 339 entries but no lastmod values, so crawlers can't tell what changed recently. Investigated: wellknown 75%.

### Agent Understanding

- [warn] Agent-navigable, token-efficient docs — 27 of 50 pages have substantive content differences between markdown and HTML (avg 42% missing). Investigated: docs 93%.
- [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%.
- [warn] Docs structured data — Only OpenGraph/meta tags across 3 assessed pages — no JSON-LD for AI answer engines to cite. Investigated: docs 50%.
- [skip] Machine-readable errors (RFC 9457) — No surface produced evidence for this capability in this run.
- [skip] Operation purpose clarity — 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

- [warn] Sandbox separation — No test-mode flag or sandbox environment is exposed. Investigated: sdk 50%.
- [pass] Runnable collection with test scripts — README is present and includes a runnable quickstart. Investigated: sdk 100%, platform 0%.
- [fail] Idempotency documented — No built-in retry machinery was found; transient failures are not retried. Investigated: sdk 0%.
- [skip] Rate-limit signaling — No surface produced evidence for this capability in this run.
- [skip] Pagination documented & consistent — No surface produced evidence for this capability in this run.

## Executive Summary

GitBook's agent discovery and documentation discoverability are strong — partners and their agents can find and parse your API surface without friction. The critical gap is in agent usability: the SDK ships no retry or idempotency machinery, meaning any transient failure in an automated workflow becomes a hard stop for partners and the AI agents integrating on their behalf. Closing this operational reliability gap is the top priority, followed by ensuring agents have richly executable, always-current context to integrate against without guessing.