BookStack API

Name: BookStack API API
Brand: BookStack API
Availability: InStock

★ Only Publicly Available OpenAPI DocumentProductivityNote TakingapiKey59 EndpointsREST

For Agents

Create and update books, chapters, and pages, export them as PDF or markdown, manage users and permissions, and search a self-hosted BookStack instance.

Quickstart

Get started with BookStack API in minutes using your preferred integration method.

# Add to your MCP client config (Claude Desktop, Cursor, Windsurf)
{
  "jentic": {
    "url": "https://api.jentic.com/mcp",
    "auth": "oauth"
  }
}

# Then ask your agent:
"create a BookStack page"

# → Jentic returns the GET /events tool with parameter schema, agent executes.

Capabilities

What an agent can do with BookStack API API.

Create books, chapters, and pages and update their content programmatically

Export any book, chapter, or page as HTML, PDF, plain text, or markdown

Search across all BookStack content with a single query endpoint

Manage users and roles to control who can read or edit each piece of content

GET STARTED

Start building with BookStack API API

Explore with Jentic

View OpenAPI Document

Use for: I need to create a new page under an existing chapter, Export the API documentation book as a single PDF, Search for the page that mentions a specific feature, Add a new user with an editor role

Not supported: Does not handle wiki rendering for end users, real-time collaborative editing, or external chat — use for BookStack content management, export, and permissions only.

Jentic publishes the only available OpenAPI document for BookStack API, keeping it validated and agent-ready.

Jentic publishes the only available OpenAPI specification for BookStack API, keeping it validated and agent-ready. BookStack is a self-hosted documentation and knowledge platform that organises content into shelves, books, chapters, and pages. The API exposes 59 endpoints covering books, chapters, pages, shelves, users, roles, attachments, the image gallery, search, the recycle bin, the audit log, and content permissions. Use it to push docs into BookStack programmatically, export pages as PDF or markdown, manage user access, and audit changes — all against a self-hosted instance.

Use Cases

Patterns agents use BookStack API API for, with concrete tasks.

★ CI-Driven Documentation Publishing

Publish documentation from a CI pipeline by creating or updating pages in BookStack whenever the source markdown changes. POST /api/pages and PUT /api/pages/{id} accept HTML or markdown content, and GET /api/pages/{id}/export/markdown lets you check in the rendered version. Removes the manual copy-paste step that doc-as-code teams otherwise live with.

PUT /api/pages/4521 with the markdown rendered from docs/install.md in the latest commit

Documentation Export and Archive

Export an entire book or chapter to PDF or markdown for offline distribution, customer downloads, or archival snapshots. GET /api/books/{id}/export/pdf and /export/markdown return the rendered file. Useful for support teams that need to ship a versioned documentation package alongside a software release.

GET /api/books/87/export/pdf and upload the response to s3://docs-archive/v24.0.0.pdf

Knowledge Base Search for Internal Tools

Surface BookStack search inside an internal tool or chat assistant so employees can find the right page without switching apps. GET /api/search runs a query across all readable content and returns matching books, chapters, and pages. Pairs well with content permissions so users only see what they can read.

GET /api/search?query='oauth setup' and return the top three results with their URLs

User Lifecycle and Permissions

Provision and deprovision BookStack users from an HRIS or SSO source so the right people have the right access at all times. POST /api/users creates the account, PUT /api/users/{id} updates roles, and DELETE /api/users/{id} removes them. PUT /api/content-permissions/{contentType}/{contentId} restricts sensitive books to specific roles.

POST /api/users with name 'Ana', email 'ana@example.com', and role_id 5 for the Editors role

AI Agent Documentation Assistant

An AI agent uses Jentic to discover BookStack operations, drafts new pages from natural-language prompts, exports books as PDF for customers, and answers questions by searching the live knowledge base. The BookStack token pair lives in the Jentic vault so the agent never sees the raw secret. Replaces a multi-day API integration with a single search-load-execute cycle per action.

Search Jentic for 'create a BookStack page', load the operation, and execute it under chapter 87 with the drafted content

Key Endpoints

59 endpoints — jentic publishes the only available openapi specification for bookstack api, keeping it validated and agent-ready.

METHOD

PATH

DESCRIPTION

POST

/api/pages

Create a page

PUT

/api/pages/{id}

Update a page

GET

/api/pages/{id}/export/pdf

Export a page as PDF

GET

/api/search

Search across all content

POST

/api/users

Create a user

PUT

/api/content-permissions/{contentType}/{contentId}

Update content permissions

GET

/api/audit-log

List audit log entries

PUT

/api/recycle-bin/{deletionId}

Restore a deleted item

POST

/api/pages

Create a page

PUT

/api/pages/{id}

Update a page

GET

/api/pages/{id}/export/pdf

Export a page as PDF

GET

/api/search

Search across all content

POST

/api/users

Create a user

PUT

/api/content-permissions/{contentType}/{contentId}

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

BookStack token ID and secret pairs are stored encrypted in the Jentic vault (MAXsystem). Agents receive a scoped, short-lived form of the credential at execution time — the raw token never enters the agent's prompt context or logs.

Intent-based discovery

Agents search Jentic with intents like 'create a BookStack page' or 'export a book as PDF' and Jentic returns the matching operation with its full input schema, removing the need to read the BookStack reference docs.

Time to first call

Direct BookStack integration: 1-2 days to wire up token auth, the page/chapter/book hierarchy, and content permissions. Through Jentic: under an hour with search, load, and execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Complementary

Bonusly API

Recognise contributors who write BookStack documentation via Bonusly bonuses.

Pair when documentation contributions should be reflected in employee recognition.

Complementary

BoldSign API

Sign-off on a BookStack policy page can be tracked through BoldSign signatures.

Pair when internal policy documentation requires acknowledged signatures.

Alternative

Boast API

Boast collects external testimonials while BookStack manages internal documentation.

Choose BookStack for internal knowledge; choose Boast for external customer voice.

FAQs

Specific to using BookStack API API through Jentic.

Why is there no official OpenAPI spec for BookStack API?

BookStack does not publish an OpenAPI specification — its docs describe the REST API as HTML reference. Jentic generates and maintains this spec so AI agents and developers can call BookStack API via structured tooling. It is validated against the live API and kept up to date. Get started at https://app.jentic.com/sign-up.

What authentication does the BookStack API use?

BookStack uses a token ID and token secret pair, sent in the Authorization header in the form 'Token {tokenId}:{tokenSecret}'. Through Jentic the pair is stored encrypted in the vault and only a scoped, short-lived form reaches the agent context.

Can I export a BookStack book or page as PDF?

Yes. GET /api/books/{id}/export/pdf returns the full book as PDF, and the same suffix works for /api/chapters/{id}/export/pdf and /api/pages/{id}/export/pdf. Markdown, HTML, and plain text variants are also available.

How do I search BookStack content through Jentic?

Search Jentic for 'search BookStack content', load the GET /api/search operation, then execute it with your query string. The response returns matching books, chapters, and pages with their URLs.

What are the rate limits for the BookStack API?

BookStack rate limits depend on your self-hosted instance configuration — there is no shared cloud limit. If your instance is behind a reverse proxy, configure throttling there and back off on HTTP 429 responses.

Can I restore a page that was deleted by accident?

Yes. List recycle bin items with GET /api/recycle-bin, find the deletionId, and restore the item with PUT /api/recycle-bin/{deletionId}. DELETE on the same path permanently removes it.