GitBook

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 organization, making it easy to audit or interact with site metadata at scale. {% openapi-schemas spec="gitbook" schemas="Site" grouped="false" %} The Site object {% endopenapi-schemas %}

GitHub OpenAPI

Operations 21

GET /orgs/{organizationId}/sites List all documentation sites in an organization #
POST /orgs/{organizationId}/sites Create a new documentation site in an organization #
GET /orgs/{organizationId}/sites/{siteId} Get a documentation site by its ID #
PATCH /orgs/{organizationId}/sites/{siteId} Update the properties of a documentation site #
DELETE /orgs/{organizationId}/sites/{siteId} Delete a site #
GET /orgs/{organizationId}/sites/{siteId}/adaptive-schema Get the visitor attributes JSON schema for an adaptive content site #
PUT /orgs/{organizationId}/sites/{siteId}/adaptive-schema Update the visitor attributes JSON schema for an adaptive content site #
GET /orgs/{organizationId}/sites/{siteId}/adaptive-schema/template-conditions List condition templates for adaptive content expressions in a site #
GET /orgs/{organizationId}/sites/{siteId}/published Get the full published profile of a site including structure and customization #
POST /orgs/{organizationId}/sites/{siteId}/publish Publish a site to make it publicly accessible #
GET /orgs/{organizationId}/sites/{siteId}/setup Get the setup steps of a site #
POST /orgs/{organizationId}/sites/{siteId}/unpublish Take a site offline by unpublishing it #
PATCH /orgs/{organizationId}/sites/{siteId}/structure/sort Move a site structure item to a new position #
GET /orgs/{organizationId}/sites/{siteId}/integration-scripts List custom scripts injected into a site's published pages #
GET /orgs/{organizationId}/sites/{siteId}/integrations List third-party integrations enabled on a site #
POST /orgs/{organizationId}/sites/{siteId}/search Full-text search across all content in a site #
POST /orgs/{organizationId}/sites/{siteId}/search/prewarm Prewarm a site's search cache #
POST /orgs/{organizationId}/sites/{siteId}/template Apply the default documentation template to a site #
POST /orgs/{organizationId}/sites/{siteId}/styleguide Create or retrieve the style guide space for a site #
POST /orgs/{organizationId}/sites/{siteId}/styleguide/runs Start a style guide check run for a site #
GET /orgs/{organizationId}/sites/{siteId}/styleguide/runs List the style guide check runs of a site #

Documentation

📖
Documentation
https://docs.gitbook.com/developers

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-sites-api-openapi.yml
⚙
AsyncAPI
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/asyncapi/gitbook-gitbook-api-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/organization.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/space.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/page.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/user.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/change-request.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/docs-site.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-schema/collection.json

Other Resources

🔗
JSONLD
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-ld/gitbook-context.jsonld

Work with this as data

Every API 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 apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • 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 API 
curl "https://apis.io/api/v1/apis/gitbook:gitbook-sites-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

gitbook-sites-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitBook Sites API
  description: The GitBook API
  termsOfService: https://policies.gitbook.com
  contact:
    name: API Support
    url: https://gitbook.com/support
    email: support@gitbook.com
  version: 0.0.1-beta
servers:
- url: '{host}/v1'
  variables:
    host:
      default: https://api.gitbook.com
security:
- user: []
- user-internal: []
- user-staff: []
- integration: []
- integration-installation: []
tags:


# --- truncated at 32 KB (243 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-sites-api-openapi.yml