Site questions

Review questions, answers, and sources generated for a docs site.

Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.

List all questions in a site

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Query parameters

typestring · enumOptional

Type classification of the user question.

Possible values:

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

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

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/questions HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-question",
      "id": "text",
      "question": "text",
      "type": "exploring",
      "createdAt": "2026-02-25T03:23:08.283Z",
      "stats": {
        "answers": 1,
        "feedback": {
          "positive": 1,
          "negative": 1,
          "unrated": 1
        },
        "answered": {
          "yes": 1,
          "partially": 1,
          "no": 1
        }
      },
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Get a site question by ID

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteQuestionIdstringRequired

The unique id of the site question

Responses

200

OK

application/json

objectstring · enumRequiredPossible values:

idstringRequired

The ID of the site question.

questionstringRequired

Canonical text for the unique site question.

typestring · enumRequired

Type classification of the user question.

Possible values:

createdAtstring · date-timeRequired

get

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

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "object": "site-question",
  "id": "text",
  "question": "text",
  "type": "exploring",
  "createdAt": "2026-02-25T03:23:08.283Z",
  "stats": {
    "answers": 1,
    "feedback": {
      "positive": 1,
      "negative": 1,
      "unrated": 1
    },
    "answered": {
      "yes": 1,
      "partially": 1,
      "no": 1
    }
  },
  "urls": {
    "location": "https://example.com"
  }
}

List all answers for a site

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

Query parameters

questionstringOptional

Filter answers to a specific site question ID.

languagestringOptional

Filter answers by ISO language code.

answeredstring · enumOptional

Whether the response answered the question.

Possible values:

confidencestring · enumOptional

Confidence in whether the response answered the question.

Possible values:

relevancestring · enumOptional

Relevance classification of the user question.

Possible values:

question.typestring · enumOptional

Type classification of the user question.

Possible values:

topicstringOptional

Filter answers by associated site topic ID.

threadstringOptional

Filter answers by thread root answer ID. Includes the root answer itself.

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/answers

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/answers HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-question-answer",
      "id": "text",
      "question": {
        "id": "text",
        "type": "exploring"
      },
      "topics": [
        "text"
      ],
      "input": {
        "text": "text",
        "raw": "text"
      },
      "thread": {
        "id": "text",
        "previous": "text"
      },
      "session": {
        "visitorId": "text",
        "sessionId": "text"
      },
      "feedback": {
        "rating": -1
      },
      "responseId": "text",
      "language": "text",
      "answered": "no",
      "confidence": "low",
      "relevance": "relevant",
      "createdAt": "2026-02-25T03:23:08.283Z",
      "updatedAt": "2026-02-25T03:23:08.283Z",
      "urls": {
        "location": "https://example.com"
      }
    }
  ]
}

Get a site answer by ID

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteQuestionAnswerIdstringRequired

The unique id of the site question answer

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "object": "site-question-answer",
  "id": "text",
  "question": {
    "id": "text",
    "type": "exploring"
  },
  "topics": [
    "text"
  ],
  "input": {
    "text": "text",
    "raw": "text"
  },
  "thread": {
    "id": "text",
    "previous": "text"
  },
  "session": {
    "visitorId": "text",
    "sessionId": "text"
  },
  "feedback": {
    "rating": -1
  },
  "responseId": "text",
  "language": "text",
  "answered": "no",
  "confidence": "low",
  "relevance": "relevant",
  "createdAt": "2026-02-25T03:23:08.283Z",
  "updatedAt": "2026-02-25T03:23:08.283Z",
  "urls": {
    "location": "https://example.com"
  },
  "response": {
    "id": "text",
    "role": "user",
    "steps": [
      {
        "content": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": "[Circular Reference]",
          "meta": {
            "token": "text"
          }
        },
        "reasoning": {
          "object": "document",
          "data": {
            "schemaVersion": 1,
            "ANY_ADDITIONAL_PROPERTY": "anything"
          },
          "nodes": "[Circular Reference]",
          "meta": {
            "token": "text"
          }
        },
        "toolCalls": [
          {
            "tool": "getPageContent",
            "spaceId": "text",
            "revisionId": "text",
            "page": {
              "id": "text",
              "type": "document",
              "title": "text",
              "path": "text"
            }
          }
        ],
        "timing": {
          "reasoning": {
            "start": "2026-02-25T03:23:08.283Z",
            "end": "2026-02-25T03:23:08.283Z"
          }
        },
        "attachments": [
          {
            "type": "image",
            "url": "https://example.com"
          }
        ]
      }
    ],
    "task": {
      "type": "respond_to_comment",
      "spaceId": "text",
      "changeRequestId": "text",
      "commentId": "text"
    },
    "response": {
      "stopReason": "aborted",
      "id": "text",
      "previous": "text"
    }
  }
}

List the sources for an answer

get

Authorizations

user

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

The unique id of the organization

siteIdstringRequired

The unique id of the site

siteQuestionAnswerIdstringRequired

The unique id of the site question answer

Query parameters

pagestringOptional

Identifier of the page results to fetch.

limitnumber · max: 1000Optional

The number of results per page

Responses

200

OK

application/json

get

/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}/sources

HTTPcURLJavaScriptPython

GET /v1/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}/sources HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

OK

{
  "next": {
    "page": "text"
  },
  "count": 1,
  "items": [
    {
      "object": "site-question-answer-source",
      "id": "text",
      "weight": 1,
      "title": "text",
      "urls": {
        "location": "https://example.com"
      },
      "type": "page",
      "space": "text",
      "revision": "text",
      "page": "text"
    }
  ]
}