# GitBook Site Context API

**Canonical:** https://apis.io/apis/gitbook/gitbook-site-context-api/  
**Provider:** GitBook — https://apis.io/providers/gitbook/  
**Documentation:** https://docs.gitbook.com/developers

GitBook Site Context API is one of 65 APIs that [GitBook](https://apis.io/providers/gitbook/) publishes on the [APIs.io](https://apis.io/) network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification. This API exposes 7 JSON Schema definitions. Tagged areas include site-context. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an AsyncAPI specification, a JSON-LD context, and 7 JSON Schemas.

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 %}

## Operations (26)

| Method | Path | Summary |
|---|---|---|
| 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 |

## Machine-readable artifacts (11)

- **OpenAPI** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/openapi/gitbook-site-context-api-openapi.yml
- **Documentation** — https://docs.gitbook.com/developers
- **AsyncAPI** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/asyncapi/gitbook-gitbook-api-asyncapi.yml
- **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
- **JSONLD** — https://raw.githubusercontent.com/api-evangelist/gitbook/refs/heads/main/json-ld/gitbook-context.jsonld

## Other GitBook APIs (12)

- [GitBook Change Request Content API](https://apis.io/apis/gitbook/gitbook-change-request-content-api/)
- [GitBook Change Request Reviewers API](https://apis.io/apis/gitbook/gitbook-change-request-reviewers-api/)
- [GitBook Change Requests API](https://apis.io/apis/gitbook/gitbook-change-requests-api/)
- [GitBook Collections API](https://apis.io/apis/gitbook/gitbook-collections-api/)
- [GitBook Custom Hostnames API](https://apis.io/apis/gitbook/gitbook-custom-hostnames-api/)
- [GitBook Imports API](https://apis.io/apis/gitbook/gitbook-imports-api/)
- [GitBook Integrations API](https://apis.io/apis/gitbook/gitbook-integrations-api/)
- [GitBook Organization Members API](https://apis.io/apis/gitbook/gitbook-organization-members-api/)
- [GitBook Organizations API](https://apis.io/apis/gitbook/gitbook-organizations-api/)
- [GitBook Site Spaces API](https://apis.io/apis/gitbook/gitbook-site-spaces-api/)
- [GitBook Space Content API](https://apis.io/apis/gitbook/gitbook-space-content-api/)
- [GitBook Spaces API](https://apis.io/apis/gitbook/gitbook-spaces-api/)

## Tags

site-context

---

Profiled by [API Evangelist](https://apievangelist.com) and published on [APIs.io](https://apis.io/apis/gitbook/gitbook-site-context-api/). The API's provider profile, Kin Score and agent-readiness rating are at https://apis.io/providers/gitbook/.