API Reference [Sample]

Get information about the state of the GitBook API

get

Access the release version and build date of the GitBook codebase

Authorizations

useruser-internaluser-staffintegrationintegration-installation

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/

HTTPcURLJavaScriptPython

GET /v1/ HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "version": "text",
  "build": "text"
}

Search content across spaces that is accessible by the currently authenticated target

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

querystring · max: 512Required

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/search

HTTPcURLJavaScriptPython

GET /v1/search?query=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "id": "text",
      "title": "text",
      "pages": [
        {
          "id": "text",
          "title": "text",
          "path": "text",
          "sections": [
            {
              "id": "text",
              "title": "text",
              "path": "text",
              "body": "text",
              "urls": {
                "app": "https://example.com"
              }
            }
          ],
          "urls": {
            "app": "https://example.com"
          }
        }
      ]
    }
  ]
}

Deprecated

Ask a question to an AI across spaces that is accessible by the currently authenticated target.

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

querystringRequired

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Responses

200

OK

application/json

default

Unexpected Error

application/json

get

/search/ask

HTTPcURLJavaScriptPython

GET /v1/search/ask?query=text HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Ask a question to an AI across spaces that is accessible by the currently authenticated target.

post

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

formatstring · enumOptional

Output format for the content.

Possible values:

detailsbooleanOptional

Return query details in the result

Body

application/json

querystringRequired

previousQueriesstring[] · max: 10OptionalDeprecated

Responses

200

OK

application/json

default

Unexpected Error

application/json

post

/search/ask

HTTPcURLJavaScriptPython

POST /v1/search/ask HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "query": "text"
}

{
  "answer": {
    "answer": {
      "markdown": "text"
    },
    "followupQuestions": [
      "text"
    ],
    "sources": [
      {
        "type": "page",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

Update the details of a space

patch

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Body

application/json

and

anyOptional

or

or

Responses

200

The space has been updated

application/json

default

Unexpected Error

application/json

patch

/spaces/{spaceId}

HTTPcURLJavaScriptPython

PATCH /v1/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 72

{
  "editMode": "live",
  "title": "text",
  "defaultLevel": "admin",
  "emoji": "🎉"
}

{
  "object": "space",
  "id": "text",
  "title": "text",
  "emoji": "🎉",
  "visibility": "public",
  "createdAt": "2025-12-16T12:14:49.384Z",
  "updatedAt": "2025-12-16T12:14:49.384Z",
  "deletedAt": "2025-12-16T12:14:49.384Z",
  "editMode": "live",
  "urls": {
    "location": "https://example.com",
    "app": "https://example.com",
    "published": "https://example.com",
    "public": "https://example.com",
    "icon": "https://example.com"
  },
  "organization": "text",
  "parent": "text",
  "gitSync": {
    "installationProvider": "github",
    "integration": "text",
    "url": "text",
    "updatedAt": "2025-12-16T12:14:49.384Z"
  },
  "visitorAuth": {
    "backend": "custom"
  },
  "revision": "text",
  "defaultLevel": "admin",
  "comments": 1,
  "changeRequests": 1,
  "changeRequestsOpen": 1,
  "changeRequestsDraft": 1,
  "permissions": {
    "access": true,
    "admin": true,
    "edit": true,
    "comment": true,
    "merge": true,
    "review": true
  }
}

Soft-deletes a space. Soft-deleted spaces will be permanently removed after 7 days.

delete

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

spaceIdstringRequired

The unique id of the space

Responses

205

Space has been deleted

default

Unexpected Error

application/json

delete

/spaces/{spaceId}

HTTPcURLJavaScriptPython

DELETE /v1/spaces/{spaceId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content