Get a single Ask AI answer by ID
Retrieves one Ask AI answer, including the question that prompted it, the response, and its feedback. Use it to inspect a specific answer discovered via listSiteQuestionAnswers.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
The unique id of the site question answer
OK
The ID of the site question answer.
The IDs of the associated site topics.
The response identifier for this answer.
ISO language code of the question.
Whether the response answered the question.
Helpfulness of the response for the end user need.
Relevance classification of the user question.
Who asked the question: human for a person using a web browser, agent for an AI agent, bot for another automated client that names itself, such as a search engine crawler, and unknown when it can't be told, such as for a script calling the API.
GET /v1/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId} HTTP/1.1
Host: api.gitbook.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
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",
"helpfulness": "low",
"relevance": "relevant",
"channel": {
"type": "site"
},
"visitorType": "human",
"createdAt": "2026-01-01T00:00:00.000Z",
"updatedAt": "2026-01-01T00:00:00.000Z",
"urls": {
"location": "https://example.com"
},
"response": {
"id": "text",
"role": "user",
"steps": [
{
"startCondition": "compaction",
"content": {
"object": "document",
"data": {},
"nodes": [
{
"object": "block",
"type": "paragraph",
"data": {},
"nodes": [
{
"object": "text",
"leaves": [
{
"object": "leaf",
"text": "Hello world",
"marks": []
}
]
}
]
}
]
},
"reasoning": {
"object": "document",
"data": {},
"nodes": [
{
"object": "block",
"type": "paragraph",
"data": {},
"nodes": [
{
"object": "text",
"leaves": [
{
"object": "leaf",
"text": "Hello world",
"marks": []
}
]
}
]
}
]
},
"toolCalls": [
{
"tool": "getPageContent",
"spaceId": "text",
"revisionId": "text",
"page": {
"id": "text",
"type": "document",
"title": "text",
"path": "text"
}
}
],
"phase": "commentary",
"timing": {
"reasoning": {
"start": "2026-01-01T00:00:00.000Z",
"end": "2026-01-01T00:00:00.000Z"
}
},
"attachments": [
{
"type": "image",
"url": "https://example.com",
"filename": "text"
}
],
"context": {
"location": {
"spaceId": "text",
"pageId": "text"
},
"comments": [
{
"id": "text",
"content": "text"
}
],
"selection": {
"anchorKey": "text",
"anchorOffset": 1,
"focusKey": "text",
"focusOffset": 1,
"content": "text"
}
}
}
],
"task": {
"type": "respond_to_comment",
"spaceId": "text",
"changeRequestId": "text",
"commentId": "text"
},
"response": {
"stopReason": "aborted",
"id": "text",
"previous": "text"
},
"createdAt": "2026-01-01T00:00:00.000Z",
"clientMessageId": "text"
},
"visitorClaims": {
"ANY_ADDITIONAL_PROPERTY": {
"ANY_ADDITIONAL_PROPERTY": "[Circular Reference]"
}
}
}Last updated
Was this helpful?