Files & storage
Set up GitBook
Connect GitBook to make your docs spaces searchable — every page of every space the token can see, in every organisation it belongs to, becomes a document, so product docs, handbooks and internal guides answer questions alongside everything else. Read-only.
Before you start
- A GitBook API token: at app.gitbook.com click your avatar → Developer settings → API tokens → Create token.
- The token reads exactly what its owner can read, across every organisation it belongs to. Only reads are ever issued — nothing in GitBook is changed.
- Documents → GitBook: paste the token into API token.
- Optionally, under Advanced, list space names exactly as GitBook shows them, one per line, under Spaces to sync only those; blank syncs every space in every organisation the token can read. A listed name GitBook doesn't have is reported in the sync summary.
- Choose access groups, Test, then Sync.
What comes in
- Each page of each matched space becomes one document titled “Space name › Page name”, fetched as Markdown; a page with no body is read from its description. Document and sheet pages are read; other entries in the space's tree are skipped, though the pages nested beneath them are read.
- GitBook stamps a revision per space, not per page — an edit re-reads that whole space's pages, and an untouched space re-reads nothing.
| Spaces | Optional space names, one per line, under Advanced. Blank syncs every space the token can see, across the first 10 organisations it reaches. |
|---|
Access
A published space (public, unlisted, share-link or visitor-gated) stays open to everyone here, matching how GitBook itself no longer bounds its readers. A private space's own reader list is mirrored automatically instead: everyone GitBook lists as having access becomes a viewer of its pages, matched by email address and re-checked on every sync; a space whose visibility comes from its collection follows that collection's readers. When a space's permissions can't be read with this token, or no listed reader has an email, its pages fall back to the access groups chosen on the source. Allow-only throughout. Switch How access works to “One list for everything” under Permissions to put everything this source brings in under the chosen access groups instead.
Test lists the spaces the token reaches and names the first few; it fails with a specific reason when GitBook rejects the token. The sync stops at the first 10 organisations, 50 spaces and 2,000 pages the token reaches and says so — narrow Spaces if that's a limit for your workspace; the cut spaces are missing from that listing, not deleted, so what already synced stays searchable. A private space's reader list is read up to 5,000 people.
Last updated 20 Sep 2026