GitBook

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,SiteTopic,SiteFinding,SiteFindingPage" grouped="false" %} The Site Context objects {% endopenapi-schemas %}

GitHub OpenAPI

Operations 26

GET /orgs/{organizationId}/sites/{siteId}/context-records List all context records #
PUT /orgs/{organizationId}/sites/{siteId}/context-records Create or update context records #
GET /orgs/{organizationId}/sites/{siteId}/context-records/{siteContextRecordId} Get a context record #
GET /orgs/{organizationId}/sites/{siteId}/scans List all site scans #
GET /orgs/{organizationId}/sites/{siteId}/scans/{siteScanId} Get a site scan by ID #
GET /orgs/{organizationId}/sites/{siteId}/findings List documentation issues GitBook has found on a site #
GET /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId} Get details of a single documentation issue #
PATCH /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId} Resolve, dismiss, or reopen a documentation issue #
GET /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/change-requests List content fixes already proposed for a documentation issue #
POST /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/change-requests Fix a documentation issue by generating a change request #
GET /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/pages List the pages affected by a documentation issue #
GET /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/questions List the Ask-AI questions evidencing a documentation issue #
GET /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/records List the source content evidencing a documentation issue #
POST /orgs/{organizationId}/sites/{siteId}/findings/{siteFindingId}/actions Apply an action to a broken link #
GET /orgs/{organizationId}/sites/{siteId}/stats/findings Get a summary of documentation issues found on a site #
GET /orgs/{organizationId}/sites/{siteId}/context-connections List all context connections #
POST /orgs/{organizationId}/sites/{siteId}/context-connections Create a context connection #
GET /orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId} Get a context connection #
PATCH /orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId} Update a context connection #
DELETE /orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId} Delete a context connection #
POST /orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId}/sync Trigger a sync for a context connection #
POST /orgs/{organizationId}/sites/{siteId}/context-connections/{siteContextConnectionId}/test Test a context connection's stored credentials #
GET /orgs/{organizationId}/sites/{siteId}/topics List all topics #
GET /orgs/{organizationId}/sites/{siteId}/topics/{siteTopicId} Get a topic #
PATCH /orgs/{organizationId}/sites/{siteId}/topics/{siteTopicId} Update a topic #
DELETE /orgs/{organizationId}/sites/{siteId}/topics/{siteTopicId}/findings Delete all documentation issues found under a topic #

Documentation

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

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-site-context-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-site-context-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-site-context-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitBook Site Context 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 (175 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-site-context-api-openapi.yml