Search

Configure and manage search settings for your content.

Ask a question to an AI within the context of the space and stream the answer as a Server-Sent Events URL.

get

/spaces/{spaceId}/search/ask/stream

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

querystringrequired

formatstring · enum

Output format for the content.

Options: document, markdown

detailsboolean

Ensure that the response is never null

Responses

text/event-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

OK

Get a list of questions that can be asked in a space.

Deprecated

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

get

/spaces/{spaceId}/search/questions

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

spaceIdstringrequired

The unique id of the space

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "questions": [
    "text"
  ]
}

OK

Stream a list of questions that can be asked in a space.

Deprecated

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

get

/spaces/{spaceId}/search/questions/stream

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

spaceIdstringrequired

The unique id of the space

Responses

text/event-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/spaces/{spaceId}/search/questions/stream' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "question": "text"
}

OK

Get a list of questions recommended to be asked in an organization.

get

/orgs/{organizationId}/ask/questions

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/ask/questions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "questions": [
    "text"
  ]
}

OK

Stream a list of questions recommended to be asked in an organization.

get

/orgs/{organizationId}/ask/questions/stream

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Responses

text/event-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/ask/questions/stream' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "question": "text"
}

OK

Ask a question to an AI across spaces that is accessible by the currently authenticated target and stream the answer as a Server-Sent Events URL.

get

/orgs/{organizationId}/ask/stream

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

querystringrequired

formatstring · enum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Responses

text/event-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

OK

Stream a list of questions that can be asked in a site.

get

/orgs/{organizationId}/sites/{siteId}/ask/questions

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

siteIdstringrequired

The unique id of the site

Responses

text/event-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites/{siteId}/ask/questions' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

default

200

{
  "question": "text"
}

OK

Ask a question to an AI 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/ask

Authorizations

Query parameters

querystringrequired

formatstring · enum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

OK

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

Deprecated

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

post

/search/ask

Authorizations

Query parameters

formatstring · enum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Body

querystringrequired

previousQueriesstring[]Deprecated

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

OK

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

application/json

cURL

JavaScript

Python

HTTP

cURL

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": [
      "text"
    ]
  }'

200

default

200

{
  "questions": [
    "text"
  ]
}

OK

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

Deprecated

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

get

/spaces/{spaceId}/search/ask

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

querystringrequired

formatstring · enum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

OK

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

post

/spaces/{spaceId}/search/ask

Authorizations

useruser-internaluser-staffintegrationintegration-installation

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

formatstring · enum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Body

querystringrequired

previousQueriesstring[]Deprecated

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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": [
      "text"
    ]
  }'

200

default

200

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

OK

Ask a question.

post

/orgs/{organizationId}/ask

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

Query parameters

formatstring · enum

Output format for the content.

Options: document, markdown

detailsboolean

Return query details in the result

Body

querystringrequired

previousQueriesstring[]Deprecated

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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": [
      "text"
    ]
  }'

200

default

200

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

OK

Ask a question in a site. The response is streamed.

post

/orgs/{organizationId}/sites/{siteId}/ask

Authorizations

Path parameters

organizationIdstringrequired

The unique id of the organization

siteIdstringrequired

The unique id of the site

Query parameters

formatstring · enum

Output format for the content.

Options: document, markdown

Body

questionstring · max: 512required

scopeone ofrequired

contextobject

You may optionally provide additional information about the context of the question. This doesn't affect the scope of the search, but GitBook may use this information to provide a better answer. Generally speaking, you should provide as much context as possible.

Responses

text/event-stream

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.gitbook.com/v1/orgs/{organizationId}/sites/{siteId}/ask' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "question": "text",
    "scope": {
      "mode": "default",
      "includedSiteSpaces": [
        "text"
      ]
    },
    "context": {
      "siteSpaceId": "text"
    }
  }'

200

default

200

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

OK

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

querystring · max: 512required

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "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"
          }
        }
      ]
    }
  ]
}

OK

Search content in a space

get

/spaces/{spaceId}/search

Authorizations

Path parameters

spaceIdstringrequired

The unique id of the space

Query parameters

querystring · max: 512required

pagestring

Identifier of the page results to fetch.

limitnumber · max: 1000

The number of results per page

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

{
  "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"
      }
    }
  ]
}

OK