Search

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

Last updated 8 days ago

Was this helpful?

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

Deprecated

This operation is deprecated and will be sunset on 2025-02-05.

get

/search

Authorizations

Query parameters

querystringrequired

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/search?query=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

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

Search content in an organization

get

/orgs/{organizationId}/search

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

querystringrequired

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/search?query=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

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

Search content in a space

get

/spaces/{spaceId}/search

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

querystringrequired

pagestring

Identifier of the page results to fetch.

limitnumber

The number of results per page

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/search?query=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

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

Ask a question.

post

/orgs/{organizationId}/ask

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

formatenum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Body

querystringrequired

previousQueriesstring[]Deprecated

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/ask' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"query":"text","previousQueries":[null]}'

200

default

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

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

post

/spaces/{spaceId}/search/ask

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

formatenum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Body

querystringrequired

previousQueriesstring[]Deprecated

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/search/ask' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"query":"text","previousQueries":[null]}'

200

default

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

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

Deprecated

This operation is deprecated and will be sunset on 2025-02-05.

post

/search/questions

Authorizations

Body

documentsstring[]required

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/search/questions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"documents":[null]}'

200

default

{
  "questions": [
    "text"
  ]
}