What Cymph uses it for
Cymph connects to GitBook for two purposes:- Importing content — fetches documentation pages and spaces. (read)
- Publishing documentation — adds a playbook’s documentation to a space as a new page. (write) See Deploy playbooks.
https://api.gitbook.com), so no instance URL is required.
If you only import, the token’s account needs read access to your spaces; publishing requires edit access — see Permissions below.
Requirements
Token setup
Create an API token from your GitBook developer settings (Account settings → Developer → API tokens).Permissions
GitBook has no per-token scope selector — a token inherits the permissions of the account that created it. What matters is the account’s role on the target spaces:What Cymph reads and writes
Cymph reads your organizations, their spaces, and page content. Publishing goes through GitBook’s change request workflow rather than writing to the live space directly — three calls, in order:
Because the merge is automatic, a published playbook lands in the live space — the change request is a mechanism, not a review gate.
Each publish inserts a new page. Cymph does not update or delete existing GitBook pages, so publishing the same playbook twice produces two pages.