Search

Search in GitBook is the entity for searches made across organizations, spaces, and pages.

GET search results from all spaces for the current user

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

GEThttps://api.gitbook.com/v1/search

Authorization

user

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of SearchSpaceResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.gitbook.com/v1/search?query=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "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"
          }
        }
      ]
    }
  ]
}

GET search results from a specific organization

Search content in an organization

GEThttps://api.gitbook.com/v1/orgs/{organizationId}/search

Authorization

user

Path parameters

organizationId*string

The unique id of the organization

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of SearchSpaceResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.gitbook.com/v1/orgs/{organizationId}/search?query=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "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"
          }
        }
      ]
    }
  ]
}

GET search results from a specific space

Search content in a space

GEThttps://api.gitbook.com/v1/spaces/{spaceId}/search

Authorization

user

Path parameters

spaceId*string

The unique id of the space

Query parameters

Response

200default

OK

Body

application/json

nextobject

countnumber

Total count of objects in the list

items*array of SearchPageResult (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/search?query=text', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer <token>"
    },
});
const data = await response.json();

Response

200default

{
  "next": {
    "page": "text"
  },
  "count": 0,
  "items": [
    {
      "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"
      }
    }
  ]
}

GitBook Lens API

POST AI Ask question on all content accessible by the authenticated user

Ask a question.

POSThttps://api.gitbook.com/v1/orgs/{organizationId}/ask

Authorization

user

Path parameters

organizationId*string

The unique id of the organization

Query parameters

Body

application/json

query*string

Response

200default

OK

Body

application/json

answerSearchAIAnswer (object)

Answer from AI for a question asked on a content.

Request

JavaScriptCurlPython

const response = await fetch('https://api.gitbook.com/v1/orgs/{organizationId}/ask', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": "text"
    }),
});
const data = await response.json();

Response

200default

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

POST AI Ask question in a specific space

Ask a question to an AI within the context of the space.

POSThttps://api.gitbook.com/v1/spaces/{spaceId}/search/ask

Path parameters

spaceId*string

The unique id of the space

Query parameters

Body

application/json

query*string

Response

200default

OK

Body

application/json

answerSearchAIAnswer (object)

Answer from AI for a question asked on a content.

Request

JavaScriptCurlPython

const response = await fetch('https://api.gitbook.com/v1/spaces/{spaceId}/search/ask', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "query": "text"
    }),
});
const data = await response.json();

Response

200default

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

POST AI Get recommended questions in a space

Get a list of questions recommended by AI for a list of content. Deprecated, use getRecommendedQuestionsInOrganization instead.

POSThttps://api.gitbook.com/v1/search/questions

Authorization

user

Body

application/json

documents*array of string

Response

200default

OK

Body

application/json

questions*array of string

Request

JavaScriptCurlPython

const response = await fetch('https://api.gitbook.com/v1/search/questions', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer <token>",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "documents": [
        "text"
      ]
    }),
});
const data = await response.json();

Response

200default

{
  "questions": [
    "text"
  ]
}