Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

REST API

Gutenberg implements a REST API using Django REST framework. The endpoint for the REST API is <GUTENBERG_INSTANCE_URL>/api/.

You can explore the API by browsing it. DRF generates interactive HTML views for all routes.

note

The auto-generated documentation is currently incomplete and in some cases displays incorrect schemas.

Authentication

The REST API supports only cookie-based session authentication. This makes it unsuitable for uses other than the Gutenberg's webapp. Support for other authentication schemes might be added in the future.