Search

Configure and manage search settings for your content.

Search content in a space

get

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

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

Ask a question.

post

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[] · max: 10Deprecated

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": [
      {
        "type": "page",
        "reason": "text",
        "page": "text",
        "revision": "text",
        "space": "text",
        "sections": [
          "text"
        ]
      }
    ]
  }
}

OK

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

get

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

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

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

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

OK

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

post

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

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.

scopeone ofrequired

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",
    "context": {
      "siteSpaceId": "text"
    },
    "scope": {
      "mode": "default",
      "includedSiteSpaces": [
        "text"
      ]
    }
  }'

200

default

200

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

OK

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

get

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