Overview
The GitBook API is currently in beta. This means you should not rely on it's availability, and that it may change without prior warning. If you wish to be one of our testers, please contact our team at [email protected].
The GitBook REST API can be used to fetch and update content on GitBook.
Authentication
There is currently one way to authenticate with GitBook API v1: by providing an authentication token. A token can be created in your GitBook user account settings.
This token can then be provided in the Authorization header of your HTTP request.
1
curl -H "Authorization: Bearer [YOUR_TOKEN]" https://$HOSTNAME/v1/user
Copied!
Pagination
Some methods return paginated results. The formatting of a paginated result is always:
1
{
2
"items": [
3
...
4
],
5
"next": {
6
"page": "..."
7
},
8
"previous": {
9
"page": "..."
10
}
11
}
Copied!
The objects
previous and next will be omitted if there are no previous or next items respectively.The
next.page and previous.page values can be added to the query parameters of the original query under the page key in order to get the next or previous page.Example
You make a GET request to a paginated endpoint
https://api.example.com/foo/bar, and receive the following response1
{
2
"items": [],
3
"next": {
4
"page": "next-page-id"
5
}
6
}
Copied!
In order to get the next page of results, you would take the ID at position
.next.page in the response body, and provide it as the value of the page key in a query to the same endpoint. The full URL including query parameters of your request to get the next page of the listing is:1
https://api.example.com/foo/bar?page=next-page-id
Copied!
Errors
GitBook uses conventional HTTP response codes to indicate the success or failure of an API request.
As a general rule:
- Codes in the
2xxrange indicate success - Codes in the
4xxrange indicate incorrect or incomplete parameters (e.g. a required parameter was omitted, or an operation failed with a 3rd party, etc.) - Codes in the
5xxrange indicate an error with GitBook's servers.
GitBook also outputs an error message and an error code formatted in JSON:
1
{
2
"error": {
3
"code": 404,
4
"message": "Page not found in this space"
5
}
6
}
Copied!
Rate limiting
Different types of API methods on GitBook.com are subject to different rate limits.
The response's HTTP headers are the authoritative source for the current number of API calls available to you or your app at any given time. The returned HTTP headers of any API request show your current rate limit status, as described below.
Header Name
Description
X-RateLimit-LimitThe maximum number of requests you're permitted to make in the current rate limit window.
X-RateLimit-RemainingThe number of requests remaining in the current rate limit window.
X-RateLimit-ResetIf you exceed the rate limit, an error response returns:
1
> HTTP/2 429
2
> X-RateLimit-Limit: 60
3
> X-RateLimit-Remaining: 0
4
> X-RateLimit-Reset: 1377013266
5
​
6
> {
7
> "error": {
8
> "code": 429
9
> "message": "API rate limit exceeded. Please try again in 60 seconds"
10
> }
11
> }
Copied!
Last modified 3mo ago
Copy link