GitBook website screenshot

GitBook

GitBook is a documentation and knowledge platform, positioned as "the knowledge layer for AI", that connects a company's docs, product and users, answers user questions with AI, and identifies gaps in its knowledge. Teams write and publish product and API documentation with docs-as-code support and AI insights built in.

GitBook publishes 65 API contracts indexed on the APIs.io network, including Change Request Content API, Change Request Reviewers API, Change Requests API, and 62 more. Tagged areas include Content, Documentation, Experience, Integration, and Platform.

The GitBook catalog on APIs.io includes 2 event-driven AsyncAPI specifications, 1 JSON-LD context, and 3 Spectral governance rulesets.

GitBook’s developer surface includes changelog, CLI, support, documentation, authentication, pricing, engineering blog, and 39 more developer resources.

61.9/100 strong ▼ -8.6 Agent 52/100 agent ready Front door AI 5/6 prominent Heartbeat 100/100 alive saas Full breakdown ↓
scored 2026-11-06 · rubric v0.27.0 · Show this score on your site →
AccessFreemiumSelf serve⚡ Free to try
1 published contract 1 MCP Servers 4 Agent Skills
ContentDocumentationExperienceIntegrationPlatformSDKAPI DocumentationDeveloper Portal

What this lets a business do 5

Business capabilities this provider's published APIs can perform, derived from its own contracts. Browse all capabilities →

SaaS Tenant Management
BC-4230
SSO
Media, Creator & Social
AE-170
space-content
Agent Infrastructure & Agentic Commerce
AE-100
site-mcp-servers
Developer Platform & API Ecosystem Management
BC-4270
Open API
POST /orgs/{organizationId}/openapi
AI Model Services
AE-110
site-ai
POST /orgs/{organizationId}/sites/{siteId}/ai/response

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-11-06 · rubric v0.27.0
Regulatory Posture applies to this provider. Its tags matched the Horizontal (data, software, accessibility, platform) regime, so Regulatory Posture carries 15 points of the composite. If this regime is wrong for your business, say so on your provider repo — the applicability map is public and we will correct it.
Create-or-Update Ergonomics applies to this provider. This API accepts writes, so it carries 10 points of the composite. It is scored from the published contracts themselves: whether a caller can create-or-update in one call, whether the write accepts a key the caller already holds, and whether the response says which branch ran. Without that, every write needs a search-and-branch in front of it, and the first time that check is skipped a duplicate record is created. Scored against the observed mean rather than raw — a provider at the catalog average is unchanged by this facet, not penalised by it.
The six quality facets above are damped to 75 points between them, because the conditional facet above carries the other 25. That is why each facet's contribution is shown against a damped maximum: raising a quality facet moves the composite by 75% of its nominal weight, not 100%. The full arithmetic is at apis.io/rating/.
Show this score on your site. Kin Score badge preview for GitBook It updates itself when the score changes. Paste this where you link to your API docs:
<a href="https://apis.io/providers/gitbook/"><img src="https://apis.io/badge/gitbook/card.svg" alt="GitBook on APIs.io — Kin Score by API Evangelist"></a>
Other styles, a README pill and a shields.io endpoint are on the badge page.
Raise your score.
Agent readiness — checks not met, largest first (exact, from this profile):
  • Idempotency +9 pts — OpenAPI mutating operations declare an idempotency key — a header, a request-body property, or a named de-duplication token whose own description says so (verified); else common[].type matches /idempoten/i (documented)
  • A2A Agent Card +8 pts — a2a/-a2a.yml manifest, graded on conformance.grade against A2A 1.0.0
  • Pagination +5 pts — share of collection GETs (an array, or one wrapped in data/items/results ...) that declare a page/limit/offset/cursor parameter, a Link header or a next/cursor field; na with no collection GETs
  • Agentic Commerce Well-Known Document +5 pts — a parsing /.well-known/ucp.json or acp.json declaring a version and at least one service, OR (0.27) a live x402 payment challenge from _data/x402-adoption.json — `self` when its endpoints are on the provider's own domain, `platform` when they are on a vendor's
  • Dry-Run / Simulate Mode +4 pts — OpenAPI: destructive operations expose a dry_run / simulate / preview / validate_only parameter
  • Well-Known Catalog +4 pts — common[].type includes WellKnown, APICatalog, or api-catalog
1 more unmet check in the Agent Readiness table above.
Kin Score — facets with the most composite points still available (weight × headroom):
Each check links to what satisfies it. Publish the artifact, or tell us where it already lives, and the score moves on the next scoring run.
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. Every facet and dimension name above is a link: it opens that measurement's own page — what it means, the exact checks that feed it, how the whole catalog distributes on it, and the providers at the top of it. This rating is computed from the provider profile at artifacts.apis.io/gitbook/apis.yml: open an issue on github.com/api-evangelist/gitbook to ask a question or point us at an artifact you publish. Submit an artifact on GitHub — free → Manage your own listing — the Influence plan, $499/mo →

What adopting GitBook moves on the Kin Score 7

GitBook is an area vendor: providers adopt it to run part of their developer surface. This is the Kin Score checks its features can move for a provider that adopts it, what each one really earns, and what it earns nothing for.

documentationmeasured10 features checked 2026-09-25 · rubric v0.22.0

GitBook earns a provider llms.txt and a docs MCP server without configuration, plus the ordinary documentation, reference, changelog and try-it pointers once the provider declares them. It stops there: GitBook serves no api-catalog, no A2A agent card and no customer-facing Agent Skills (its own SKILL.md teaches agents to edit GitBook, not to use the provider’s API), and the per-site MCP server is one template, graded platform. Contract Quality is untouched because GitBook renders the OpenAPI it is given.

Agent Readiness4.8 of 139 pts
Developer Ergonomics10.0 of 42 pts
Discoverability4.0 of 54 pts
Operational Transparency6.0 of 38 pts
CheckEarnsThrough
MCP Serverplatform
Agent Readiness · customers +4.5 pts vs controlOne GitBook-hosted template on every published site that reads docs and does not call the API; 0.22.0 grades that platform (0.25 of 12). It is also disabled if page actions are off.
3.0 of 12 MCP server for published docs
Request/Response Examplespartial
Agent Readiness · customers -11.6 pts vs controlThe dimension reads examples inside the OpenAPI first; code samples GitBook renders reach only the Examples / Code Samples link fallback.
1.8 of 7 Custom code samples
Change log
Operational Transparency · customers -18.5 pts vs controlUse the updates block on a paid plan, keep posting, and declare the page as a ChangeLog pointer.
6.0 of 6 Updates block (changelog) with RSS
Publishes llms.txt
Discoverability · customers +11.7 pts vs controlGenerated from the provider’s own pages on the provider’s domain, so it reads as the provider’s llms.txt (rule 2’s own-content, own-domain case).
4.0 of 4 llms.txt, llms-full.txt and Markdown pages
Documentationsaturated
Developer Ergonomics · customers +5.1 pts vs control95% of providers with a contract, docs and a reference already earn this; the vendor cannot move it for most of its buyers.
4.0 of 4 Published docs site on a custom domain
Console or sandbox
Developer Ergonomics · customers -1.3 pts vs controlDeclare the reference page as a Console / Playground pointer.
3.0 of 3 OpenAPI reference blocks with Test it
API referencesaturated
Developer Ergonomics · customers +3.8 pts vs control94% of providers with a contract, docs and a reference already earn this; the vendor cannot move it for most of its buyers.
3.0 of 3 OpenAPI reference blocks with Test it
47 detected customers vs 5169 comparable providers: composite 45.5 vs 48.1, agent readiness 31.2 vs 32.5. Association, not cause.
Across 8977 providers that publish a contract, adopting GitBook would move 8756. Median lift: composite +3.6 (90th percentile +5.7), agent readiness +2.2 (+3.5). Conditional rows excluded.
What GitBook ships that earns nothing (3)
  • GitBook's own SKILL.md — The skill teaches agents to use GitBook itself; it says nothing about the provider’s API and is not served as the provider’s skill.
  • MCP server card — An MCP server card is not one of the four documents the check reads, and GitBook serves no api-catalog.
  • OpenAPI reference blocks with Test it — Rendering the spec writes no examples back into it.

A model, not a score. Adopting this vendor changes a provider's Kin Score only when the provider publishes the resulting artifacts on its own surface; nothing here writes a score, and no sponsorship or partnership can. The rating is not for sale → · Full vendor facets artifact

Markets this provider is in provisional

The Kin Score Market layer reads a provider inside its market: its position, and how deep its integrations go. Depth is only comparable within a position. Provisional and unweighted: not part of the Kin Score or agent readiness.

MarketPositionDepthRegistered MCP serverDeclares compatibility
Content, Documentation and Design Platforms builds-on 38.3 - 1
Agent Skills (SKILL.md packages) builds-on 38.3 - 1

Registered MCP server and declares compatibility are report only — not weighted. Undeclared means we found nothing we can read, so there is no number: we never infer integrations.

Standards implemented 4

Standards this provider implements or carries. De facto ones are profiled and measured by the API Commons; formal ones come from the standards directory and are linked by the provider's own tags. The evidence column says how each claim was established — not that it was made.

measured — observed by APIs.io (verified)
measured — observed by APIs.io (verified)
measured — observed by APIs.io (published)
measured — observed by APIs.io (published)

APIs 65

Individual APIs this provider publishes, each with its own machine-readable definition.

GitBook Change Request Content API

Manage content within a change request.

GitBook Change Request Reviewers API

Manage reviewers for change requests.

GitBook Change Requests API

Create, list, review, merge, and update change requests for collaborative editing.

GitBook Collections API

Organize and manage grouped sets of spaces.

GitBook Custom Hostnames API

Configure custom hostnames for docs sites.

GitBook Imports API

Import content into spaces.

GitBook Integrations API

Install and manage third-party integrations.

GitBook Organization Members API

Manage members and their roles within an organization.

GitBook Organizations API

Create and configure organizations to group users, spaces, and collections.

GitBook Site Spaces API

Manage spaces within a docs site.

GitBook Space Content API

Manage pages and content within a space.

GitBook Spaces API

Manage spaces which are containers for documentation or knowledge base content.

GitBook URLs API

Resolve and manage content URLs.

GitBook Users API

Manage user accounts and profiles.

GitBook Agents API

The agents API from GitBook — 3 operation(s) for agents.

GitBook Billing API

Centralize billing activities here, including updating payment methods, adjusting subscriptions, or reviewing invoices. Simplify how you track and control costs.

GitBook Change Request Comments API

This API powers the inline discussion around any new or updated documentation. Participate in comment threads and resolve them after reaching consensus. {% openapi-schemas spec=...

GitBook Change Request Contributors API

Quickly access the full list of collaborators and their contributions within a change request for better traceability and communication. {% openapi-schemas spec="gitbook" schema...

GitBook Change Request Conversations API

The change-request-conversations API from GitBook — 2 operation(s) for change-request-conversations.

GitBook Change Requests Reviews API

The change-requests-reviews API from GitBook — 3 operation(s) for change-requests-reviews.

GitBook Collection Permissions API

Control which users and teams have access to a collection's spaces. This ensures only the right individuals can view or modify sensitive content.

GitBook Critical API

The critical API from GitBook — 12 operation(s) for critical.

GitBook Custom Fonts API

Upload and manage custom fonts for branding or aesthetic purposes. Once added, fonts can be applied to your spaces or sites to achieve a unique look. {% openapi-schemas spec="gi...

GitBook Git API

The git API from GitBook — 9 operation(s) for git.

GitBook Glossary API

Define terms and specify their translations for different languages to ensure consistent wording. {% openapi-schemas spec="gitbook" schemas="GlossaryEntry" grouped="false" %} Th...

GitBook Openapi Versions API

Keep a history of your OpenAPI specs, enabling you to compare different versions, revert, or maintain multiple concurrent versions for testing or documentation. {% openapi-schem...

GitBook Organization Ask API

Enhance your team's knowledge base with the Organization AI ask endpoint, which allows you to query AI models trained on your organization's GitBook content for quick, intellige...

GitBook Organization Invites API

Use this API to create and revoke invitations for new members. By automating invite flows, you can maintain a cohesive onboarding experience for collaborators and speed up team ...

GitBook Site Ads API

Manage the advertisement strategy within your docs. You can specify ad placements, track usage, and adjust settings to best fit your organization's needs.

GitBook Site Agent Feedback API

Collect structured feedback from AI agents about the tools, operations, commands and content they worked with, so you can see where agents struggle instead of only how often the...

GitBook Site Agent Settings API

Configure how site issue remediation should behave and provide site-specific instructions for the editing and topic analyst agents. {% openapi-schemas spec="gitbook" schemas="Si...

GitBook Site AI API

Build advanced conversational AI experiences within your docs site that go beyond basic Q&A.

GitBook Site Ask API

Give your users a way to ask content-aware AI queries that are scoped entirely to the site's published documents.

GitBook Site Change Requests API

A site change request groups changes to a site's structure and to the content of any number of its spaces into one review, with a single lifecycle and a single merge decision. {...

GitBook Site Channels API

Manage the channels used as origins for questions and answers in your site ask data. {% openapi-schemas spec="gitbook" schemas="SiteChannel" grouped="false" %} The SiteChannel o...

GitBook Site Context API

Manage the contextual records and topics used by your site to power AI experiences and insights. {% openapi-schemas spec="gitbook" schemas="ContextRecord,ContextConnection,SiteT...

GitBook Site Customization API

Update your site's branding, styling, and layout to match your organization's identity. This includes theming elements like color palette, logos, and more. {% openapi-schemas sp...

GitBook Site External Links API

External links add absolute HTTP or HTTPS destinations alongside sections and groups in a site's navigation. {% openapi-schemas spec="gitbook" schemas="SiteExternalLink" grouped...

GitBook Site Insights API

This API delivers insights about how visitors interact with your site, including page views and user engagement, helping you measure and optimize your content strategy.

GitBook Site MCP Servers API

Manage Model Context Protocol (Mcp) servers used by your site. {% openapi-schemas spec="gitbook" schemas="SiteMcpServer" grouped="false" %} The SiteMcpServer object {% endopenap...

GitBook Site Permissions API

Invite, remove, or update users and teams permissions for a site. This provides a way to tightly control collaboration and visibility among your teammates.

GitBook Site Preview API

Quickly generate a preview of how your site's content and layout will appear once published, allowing for final checks and refinement prior to going live.

GitBook Site Publishing Auth API

Configure the credentials or tokens required to publish documentation externally. This helps ensure your site is consistently kept up to date. {% openapi-schemas spec="gitbook" ...

GitBook Site Questions API

Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer. {% openapi-schemas spec="gitbook" schema...

GitBook Site Redirects API

Keep your site's content fresh without breaking old links. This API allows you to create and manage redirection rules. {% openapi-schemas spec="gitbook" schemas="SiteRedirect" g...

GitBook Site Section Groups API

Section groups let you bundle multiple top-level sections together, offering additional structuring capabilities and simplifying navigation for your readers. {% openapi-schemas ...

GitBook Site Sections API

Sections help partition your site's content at the top level. They can be modified, deleted, or reorganized to reflect your site's changing structure. {% openapi-schemas spec="g...

GitBook Site Share Links API

Manage the lifecycle of share links for your published sites. This includes generating new links for external sharing and revoking or updating existing ones. {% openapi-schemas ...

GitBook Site Structure API

Provides a complete overview of how content is organized on a site. With this API, you can discover page nesting, identify sections, and reorder site elements as needed. {% open...

GitBook Site Users API

The site-users API from GitBook — 3 operation(s) for site-users.

GitBook Sites API

The Docs Sites API lets you programmatically manage published documentation sites within your organization. You can list and update all sites created under a specific organizati...

GitBook Space Comment API

The space-comment API from GitBook — 1 operation(s) for space-comment.

GitBook Space Comments API

Comments are a powerful way to gather feedback on your documentation. Use this API to post, list, update, or delete comments and keep conversations organized. {% openapi-schemas...

GitBook Space Embeds API

Automatically fetch metadata or previews for embedded resources such as videos, images, or external docs, enabling richer content experiences in your space.

GitBook Space Git API

Manage the linkage between your GitBook space and external Git repositories, enabling commits, merges, and pull requests directly tied to your documentation.

GitBook Space Integrations API

This API handles the registration and removal of integrations, automating how data flows between GitBook and your chosen external services.

GitBook Space Permissions API

Give your collaborators the right level of access for specific spaces, or assign entire teams to your spaces and streamline the process of granting or revoking access at scale, ...

GitBook SSO API

Tie GitBook into your corporate identity management and authentication providers (like SAML or OAuth). This centralizes user authentication and improves security. {% openapi-sch...

GitBook Storage API

Whether you're hosting images, documents, or other assets, Storage endpoints allow you to integrate those files into your documentation and spaces seamlessly.

GitBook Subdomains API

Provide a branded subdomain for each organization to create a consistent user experience. This API supports subdomain creation, DNS checks, and more. {% openapi-schemas spec="gi...

GitBook System API

Use these endpoints to monitor the overall health of GitBook's infrastructure or to retrieve version information for debugging and compliance purposes.

GitBook Team Members API

Easily add or remove users from teams, as well as fine-tune their specific roles within a team to ensure secure, well-organized collaboration. {% openapi-schemas spec="gitbook" ...

GitBook Teams API

Teams offer a convenient way to assign roles and access to multiple users at once. This helps maintain large-scale projects more efficiently by reducing overhead in user-by-user...

GitBook Translations API

The Translations API provides ways to localize your content into various languages. It supports custom strings, default language settings, and more.

GitBook Open API

The OpenAPI endpoints let you integrate your existing or newly generated OpenAPI definitions into GitBook. This includes uploading, updating, and retrieving specs. {% openapi-sc...

Scroll for all 65

Open Collections 19

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

GitBook API

OPEN COLLECTION

Scroll for all 19

MCP Servers 1

Model Context Protocol servers that expose these APIs to AI agents.

GitBook MCP Server

Remote MCP server at mcp.gitbook.com over HTTP.

MCP SERVER

Agent Skills 4

Packaged agent skills for driving this provider's APIs from an AI assistant.

GitBook API pricing

Prices published by GitBook, read 2026-10-28 from www.gitbook.com/pricing.

PlanPrice
Free $0/mo per site
Includes: 1 free user; GitBook Agent 10 message limit per week
Essential $65/mo + $12 per user/mo per site/month
Includes: Includes $20 of AI credits (2,000 credits)
Ultimate $249/mo + $12 per user/mo per site/month
Includes: Includes $100 of AI credits (10,000 credits)
Enterprise Custom
AI credits bundle 5,000 5,000 AI credits — $47.50 p/m
AI credits bundle 10,000 10,000 AI credits — $90 p/m
AI credits bundle 15,000 15,000 AI credits — $127.50 p/m
AI credits bundle 40,000 40,000 AI credits — $300 p/m

Plan details, limits and sources →

Rate limits

Compiled by API Evangelist, not yet checked against GitBook's documentation. All 5 limits →

Billed by: site/month · FinOps profile →

Pricing Plans 2

Published pricing tiers and plan structures.

Gitbook Plans Pricing

8 plans

PLANS

Rate Limits 1

Documented rate limits and quota policies.

Gitbook Rate Limits

5 limits

RATE LIMITS

Service Levels 1

Uptime the provider promises or reports, as SLA4OAI. Read from its own pages; APIs.io runs no monitors.

GitBook

SLA

FinOps 1

Cost, billing, and metering signals for API financial operations.

Event Specifications 2

AsyncAPI definitions for this provider's event-driven and streaming APIs.

GitBook Webhook Events

AsyncAPI specification for GitBook webhook events. GitBook emits webhook notifications when key events occur within organizations, spaces, pages, change requests, docs sites, co...

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Gitbook Context

0 classes · 7 properties

JSON-LD

Spectral Rules 3

Spectral governance rulesets for linting and validating these APIs.

GitBook — asyncapi rules

7 rules · 1 errors 5 warnings 1 info

SPECTRAL

GitBook — jsonschema rules

5 rules · 3 warnings 2 info

SPECTRAL

GitBook API Rules

18 rules · 15 errors 1 warnings 2 info

SPECTRAL

OpenAPI Overlays 1

Overlays applied on top of this provider's contracts. Each card says who wrote it: a document the provider publishes, or one API Evangelist derived or generated.

Gitbook Openapi Overlay

0 actions · update

UNRECORDED

JSON Schema 7

Standalone JSON Schema definitions for this provider's data models.

GitBook Change Request

9 properties

JSON SCHEMA

GitBook Collection

5 properties

JSON SCHEMA

GitBook Docs Site

6 properties

JSON SCHEMA

GitBook Organization

5 properties

JSON SCHEMA

GitBook Page

7 properties

JSON SCHEMA

GitBook Space

8 properties

JSON SCHEMA

GitBook User

5 properties

JSON SCHEMA

Scroll for all 7

Security Posture 2

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Gitbook Authentication

http · 1 scheme

SECURITY

Gitbook Domain Security

TLSv1.3 · HSTS · DNSSEC · DMARC

SECURITY

Scopes 1

OAuth scopes governing access to this provider's APIs.

Gitbook Scopes

29 scopes · authorizationCode

29 scopes

SCOPES

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Gitbook Agentic Access

64 operations · 32 acting

64 operations · 32 acting

AGENTIC

Resources

Get Started 2

Portal, sign-up, and the first successful call

Documentation 3

Reference material describing how the API behaves

Agent Surfaces 5

MCP servers, agent skills, and machine-readable catalogs

Design & Contract 10

Pagination, idempotency, versioning, errors, and events

Scroll for all 10

Build 5

SDKs, sample code, and the tooling you integrate with

Access & Security 4

Authentication, authorization, and security posture

Operate 5

Status, limits, changes, and where to get help

Commercial 5

Pricing, plans, and the legal terms of use

Company 3

The organization behind the API

Other 4

Properties that don't map to a standard resource type

Source (apis.yml)

apis.yml Raw ↑
aid: gitbook
url: https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/apis.yml
name: GitBook
x-docs-platform: gitbook
x-docs-platform-confidence: high
x-docs-platform-checked: 2026-10-04
tags:
- Content
- Documentation
- Experience
- Integration
- Platform
- SDK
- API Documentation
- Developer Portal
deliveryModel:
  model: saas
  open_source: false
  commercial: true
  callable_host: true
  label: Hosted service · you call their endpoint
  confidence: high
  source:
  - openapi
  - pricing
  generated: '2026-08-28'
  method: derived
accessModel:
  pricing: freemium
  onboarding: self-serve
  trial: false
  try_now: true
  public: false
  gated: none
  gated_source:
  - onboarding
  label: Freemium · Self-serve signup
  confidence: medium
  source:
  - plans
  - authentication
  - security
  generated: '2026-11-06'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/gitbook.png
access: 3rd-Party
created: '2025-01-08'
modified: '2026-05-19'
position: Consuming
description: GitBook is a documentation and knowledge platform, positioned as "the knowledge layer for AI", that connects
  a company's docs, product and users, answers user questions with AI, and identifies gaps in its knowledge. Teams write and
  publish product and API documentation with docs-as-code support and AI insights built in.
maintainers:
- FN: Kin Lane
  email: info@apievangelist.com
specificationVersion: '0.23'
common:
- type: CapabilityMap
  url: capabilities/gitbook-capability-edges.yml
  name: GitBook Business Capability Map
- type: ChangeLog
  url: changelog/gitbook-changelog.yml
- type: OAuthScopes
  url: scopes/gitbook-scopes.yml
- type: FinOps
  url: finops/gitbook-finops.yml
- type: RateLimits
  url: rate-limits/gitbook-rate-limits.yml
- type: Plans
  url: plans/gitbook-plans-pricing.yml
- type: Spectral
  url: rules/gitbook-rules.yml
- type: Spectral
  url: rules/gitbook-jsonschema-spectral-rules.yml
- type: Spectral
  url: rules/gitbook-asyncapi-spectral-rules.yml
- type: Vocabulary
  url: vocabulary/gitbook-vocabulary.yml
- type: AgentSkill
  url: skills/_index.yml
- type: Webhooks
  url: asyncapi/gitbook-webhooks.yml
- type: DataModel
  url: data-model/gitbook-data-model.yml
- type: CLI
  url: cli/gitbook-cli.yml
- type: Conventions
  url: conventions/gitbook-conventions.yml
- type: ErrorCatalog
  url: errors/gitbook-problem-types.yml
- type: Conformance
  url: conformance/gitbook-conformance.yml
- type: LLMsTxt
  url: llms/gitbook-llms.txt
- type: MCPServer
  url: mcp/gitbook-mcp.yml
- type: WellKnown
  url: well-known/gitbook-well-known.yml
- type: Hosts
  url: hosts/gitbook-hosts.yml
- type: Vendors
  url: vendors/gitbook-vendors.yml
- type: SDKs
  url: packages/gitbook-packages.yml
- type: Packages
  url: packages/gitbook-packages.yml
- type: Webhooks
  url: https://www.gitbook.com/integrations/webhook
- type: Support
  url: https://www.gitbook.com/solutions/help-center
- type: Security
  url: https://www.gitbook.com/industries/security
- type: Documentation
  url: https://developer.gitbook.com/
- type: VendorFacets
  url: vendor-facets/gitbook-vendor-facets.yml
- type: AgenticAccess
  url: agentic-access/gitbook-agentic-access.yml
- type: DomainSecurity
  url: security/gitbook-domain-security.yml
- type: Authentication
  url: authentication/gitbook-authentication.yml
- type: GitHubOrganization
  url: https://github.com/gitbookio
- type: LinkedIn
  url: https://www.linkedin.com/company/gitbook
- url: https://www.gitbook.com/
  name: GitBook
  type: Website
  description: Transform your documentation into a connected knowledge system — one that learns, optimizes, and improves itself
    intelligently
- url: https://www.gitbook.com/pricing
  name: GitBook – Pricing
  type: Pricing
  description: 'null'
- url: https://www.gitbook.com/blog
  name: GitBook – Blog
  type: Blog
  description: 'null'
- url: https://gitbook.com/docs/guides
  name: GitBook guides | Guides | GitBook Documentation
  type: Guide
  description: 'null'
- type: Integrations
  url: https://www.gitbook.com/integrations
- type: SignUp
  url: https://app.gitbook.com/join
- type: GettingStarted
  url: https://gitbook.com/docs
- type: ChangeLog
  url: https://gitbook.com/docs/changelog
- type: StatusPage
  url: https://www.gitbookstatus.com/
- type: TermsOfService
  url: https://gitbook.com/docs/policies/terms
- type: PrivacyPolicy
  url: https://gitbook.com/docs/policies/privacy-and-security/statement
- type: APIReference
  url: https://gitbook.com/docs/developers
- type: SDK
  url: https://www.npmjs.com/package/@gitbook/api
  generated: '2026-10-05'
  method: probed
  source:
  - npmjs
apis:
- aid: gitbook:gitbook-change-request-content-api
  name: GitBook Change Request Content API
  description: Manage content within a change request.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Change Request Content
  properties:
  - type: OpenAPI
    url: openapi/gitbook-change-request-content-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-change-request-reviewers-api
  name: GitBook Change Request Reviewers API
  description: Manage reviewers for change requests.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Change Request Reviewers
  properties:
  - type: OpenAPI
    url: openapi/gitbook-change-request-reviewers-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-change-requests-api
  name: GitBook Change Requests API
  description: Create, list, review, merge, and update change requests for collaborative editing.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Change Requests
  properties:
  - type: OpenAPI
    url: openapi/gitbook-change-requests-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-collections-api
  name: GitBook Collections API
  description: Organize and manage grouped sets of spaces.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Collection
  tags_raw:
  - Collections
  properties:
  - type: OpenAPI
    url: openapi/gitbook-collections-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-custom-hostnames-api
  name: GitBook Custom Hostnames API
  description: Configure custom hostnames for docs sites.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Custom Hostnames
  properties:
  - type: OpenAPI
    url: openapi/gitbook-custom-hostnames-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-imports-api
  name: GitBook Imports API
  description: Import content into spaces.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Import
  tags_raw:
  - Imports
  properties:
  - type: OpenAPI
    url: openapi/gitbook-imports-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-integrations-api
  name: GitBook Integrations API
  description: Install and manage third-party integrations.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Integration
  tags_raw:
  - Integrations
  properties:
  - type: OpenAPI
    url: openapi/gitbook-integrations-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-organization-members-api
  name: GitBook Organization Members API
  description: Manage members and their roles within an organization.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Organization Members
  properties:
  - type: OpenAPI
    url: openapi/gitbook-organization-members-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-organizations-api
  name: GitBook Organizations API
  description: Create and configure organizations to group users, spaces, and collections.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Organization
  tags_raw:
  - Organizations
  properties:
  - type: OpenAPI
    url: openapi/gitbook-organizations-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-site-spaces-api
  name: GitBook Site Spaces API
  description: Manage spaces within a docs site.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Site Spaces
  properties:
  - type: OpenAPI
    url: openapi/gitbook-site-spaces-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-space-content-api
  name: GitBook Space Content API
  description: Manage pages and content within a space.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Space Content
  properties:
  - type: OpenAPI
    url: openapi/gitbook-space-content-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-spaces-api
  name: GitBook Spaces API
  description: Manage spaces which are containers for documentation or knowledge base content.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Spaces
  - Space
  tags_raw:
  - Spaces
  - Space
  properties:
  - type: OpenAPI
    url: openapi/gitbook-spaces-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-urls-api
  name: GitBook URLs API
  description: Resolve and manage content URLs.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - URLs
  properties:
  - type: OpenAPI
    url: openapi/gitbook-urls-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-users-api
  name: GitBook Users API
  description: Manage user accounts and profiles.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - User
  tags_raw:
  - Users
  properties:
  - type: OpenAPI
    url: openapi/gitbook-users-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-agents-api
  name: GitBook Agents API
  description: The agents API from GitBook — 3 operation(s) for agents.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Agents
  tags_raw:
  - agents
  properties:
  - type: OpenAPI
    url: openapi/gitbook-agents-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-billing-api
  name: GitBook Billing API
  description: Centralize billing activities here, including updating payment methods, adjusting subscriptions, or reviewing
    invoices. Simplify how you track and control costs.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Billing
  tags_raw:
  - billing
  properties:
  - type: OpenAPI
    url: openapi/gitbook-billing-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-change-request-comments-api
  name: GitBook Change Request Comments API
  description: "This API powers the inline discussion around any new or updated documentation. Participate in comment threads\
    \ and resolve them after reaching consensus.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"Comment\" grouped=\"false\"\
    \ %}\n    The Comment object\n{% endopenapi-schemas %}"
  humanURL: https://docs.gitbook.com/developers
  tags:
  - change-request-comments
  properties:
  - type: OpenAPI
    url: openapi/gitbook-change-request-comments-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-change-request-contributors-api
  name: GitBook Change Request Contributors API
  description: "Quickly access the full list of collaborators and their contributions within a change request for better traceability\
    \ and communication.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"UserContributor\" grouped=\"false\" %}\n    The\
    \ UserContributor object\n{% endopenapi-schemas %}"
  humanURL: https://docs.gitbook.com/developers
  tags:
  - change-request-contributors
  properties:
  - type: OpenAPI
    url: openapi/gitbook-change-request-contributors-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-change-request-conversations-api
  name: GitBook Change Request Conversations API
  description: The change-request-conversations API from GitBook — 2 operation(s) for change-request-conversations.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - change-request-conversations
  properties:
  - type: OpenAPI
    url: openapi/gitbook-change-request-conversations-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-change-requests-reviews-api
  name: GitBook Change Requests Reviews API
  description: The change-requests-reviews API from GitBook — 3 operation(s) for change-requests-reviews.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - change-requests-reviews
  properties:
  - type: OpenAPI
    url: openapi/gitbook-change-requests-reviews-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-collection-permissions-api
  name: GitBook Collection Permissions API
  description: Control which users and teams have access to a collection's spaces. This ensures only the right individuals
    can view or modify sensitive content.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - collection-permissions
  properties:
  - type: OpenAPI
    url: openapi/gitbook-collection-permissions-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-critical-api
  name: GitBook Critical API
  description: The critical API from GitBook — 12 operation(s) for critical.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - critical
  properties:
  - type: OpenAPI
    url: openapi/gitbook-critical-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-custom-fonts-api
  name: GitBook Custom Fonts API
  description: "Upload and manage custom fonts for branding or aesthetic purposes. Once added, fonts can be applied to your\
    \ spaces or sites to achieve a unique look.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"CustomizationFontDefinition\"\
    \ grouped=\"false\" %}\n    The CustomizationFontDefinition object\n{% endopenapi-schemas %}"
  humanURL: https://docs.gitbook.com/developers
  tags:
  - custom-fonts
  properties:
  - type: OpenAPI
    url: openapi/gitbook-custom-fonts-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-git-api
  name: GitBook Git API
  description: The git API from GitBook — 9 operation(s) for git.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Version Control
  tags_raw:
  - git
  properties:
  - type: OpenAPI
    url: openapi/gitbook-git-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-glossary-api
  name: GitBook Glossary API
  description: "Define terms and specify their translations for different languages to ensure consistent wording.\n\n{% openapi-schemas\
    \ spec=\"gitbook\" schemas=\"GlossaryEntry\" grouped=\"false\" %}\n    The GlossaryEntry object\n{% endopenapi-schemas\
    \ %}"
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Glossary
  tags_raw:
  - glossary
  properties:
  - type: OpenAPI
    url: openapi/gitbook-glossary-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-openapi-versions-api
  name: GitBook Openapi Versions API
  description: "Keep a history of your OpenAPI specs, enabling you to compare different versions, revert, or maintain multiple\
    \ concurrent versions for testing or documentation.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"OpenAPISpecVersion\"\
    \ grouped=\"false\" %}\n    The OpenAPISpecVersion object\n{% endopenapi-schemas %}"
  humanURL: https://docs.gitbook.com/developers
  tags:
  - openapi-versions
  properties:
  - type: OpenAPI
    url: openapi/gitbook-openapi-versions-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-organization-ask-api
  name: GitBook Organization Ask API
  description: Enhance your team's knowledge base with the Organization AI ask endpoint, which allows you to query AI models
    trained on your organization's GitBook content for quick, intelligent responses.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - organization-ask
  properties:
  - type: OpenAPI
    url: openapi/gitbook-organization-ask-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-organization-invites-api
  name: GitBook Organization Invites API
  description: Use this API to create and revoke invitations for new members. By automating invite flows, you can maintain
    a cohesive onboarding experience for collaborators and speed up team expansion.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - Organization Invites
  tags_raw:
  - organization-invites
  properties:
  - type: OpenAPI
    url: openapi/gitbook-organization-invites-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json
  - type: JSONSchema
    url: json-schema/docs-site.json
  - type: JSONSchema
    url: json-schema/collection.json
  - type: JSONLD
    url: json-ld/gitbook-context.jsonld
- aid: gitbook:gitbook-site-ads-api
  name: GitBook Site Ads API
  description: Manage the advertisement strategy within your docs. You can specify ad placements, track usage, and adjust
    settings to best fit your organization's needs.
  humanURL: https://docs.gitbook.com/developers
  tags:
  - site-ads
  properties:
  - type: OpenAPI
    url: openapi/gitbook-site-ads-api-openapi.yml
  - type: Documentation
    url: https://docs.gitbook.com/developers
  - type: AsyncAPI
    url: asyncapi/gitbook-gitbook-api-asyncapi.yml
  - type: JSONSchema
    url: json-schema/organization.json
  - type: JSONSchema
    url: json-schema/space.json
  - type: JSONSchema
    url: json-schema/page.json
  - type: JSONSchema
    url: json-schema/user.json
  - type: JSONSchema
    url: json-schema/change-request.json


# --- truncated at 32 KB (72 KB total) ---
# Full source: https://artifacts.apis.io/gitbook/apis.yml

GitBook API — frequently asked questions

Does GitBook have an API?

Yes. APIs.io lists 65 APIs from GitBook, including GitBook Change Request Content API, GitBook Change Request Reviewers API and GitBook Change Requests API, and 62 more.

Is there an OpenAPI specification for the GitBook API?

Yes. APIs.io indexes 65 OpenAPI specifications for GitBook, each linked for download from this page.

How do I authenticate with the GitBook API?

GitBook documents its authentication (http · 1 scheme). The details are profiled on APIs.io as Gitbook Authentication.

How much does the GitBook API cost?

GitBook publishes its prices; its Free plan is $0/mo per site as of 2026-10-28. APIs.io lists 8 pricing plans for GitBook, with each plan's price, limits and inclusions under Pricing on this page.

Does GitBook have an MCP server?

Yes. APIs.io lists 1 MCP server for GitBook: Remote MCP server at mcp.gitbook.com over HTTP.

Is the GitBook API ready for AI agents?

GitBook has a Kin Score of 61.9 out of 100 (strong) and an Agent Readiness score of 52.1 (agent-ready), scored by API Evangelist on 2026-11-06.

Work with this as data

Every provider here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for providers

9 MCP tools reach this
  • find_providersBrowse and filter every provider in the catalog.
  • get_provider_artifactsEvery artifact this provider publishes, grouped by type.
  • get_provider_operationsEvery operation across all of their OpenAPIs — one call instead of parsing every spec.
  • get_provider_toolsEvery MCP tool they ship, with the operation each wraps.
  • get_provider_evidenceHow each part of their score was established. Free — the basis for a claim should not sit behind it.
  • get_provider_ratingPRO — composite, band, trend and facet scores.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This provider
curl "https://apis.io/api/v1/providers/gitbook"
All providers
curl "https://apis.io/api/v1/providers?limit=25"
Every operation they expose
curl "https://apis.io/api/v1/providers/gitbook/operations?limit=25"
How their score was established
curl "https://apis.io/api/v1/providers/gitbook/evidence"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.