Ask AI

Ask questions in the context of a site.

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

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

Authorization

user

Path parameters

organizationId*string

The unique id of the organization

siteId*string

The unique id of the site

Query parameters

Body

application/json

question*string

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.

scope*SiteSearchScope (one of)

objectobjectobject

Response

200default

OK

Body

text/event-stream

type*enum

answer

answer*SearchAIAnswer (object)

Answer from AI for a question asked on a content.

Request

JavaScriptCurlPythonHTTP

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

Response

200default

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