# Site questions

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

## The SiteQuestion object

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"components":{"schemas":{"SiteQuestion":{"type":"object","properties":{"object":{"type":"string","enum":["site-question"]},"id":{"type":"string","description":"The ID of the site question."},"question":{"type":"string","description":"Canonical text for the unique site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"askedAt":{"$ref":"#/components/schemas/Timestamp"},"stats":{"$ref":"#/components/schemas/SiteQuestionStats"},"urls":{"type":"object","description":"URLs associated with the site question.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question in the API."}},"required":["location"]}},"required":["object","id","question","type","createdAt","askedAt","stats","urls"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"Timestamp":{"type":"string","format":"date-time"},"SiteQuestionStats":{"type":"object","description":"Aggregated stats for questions and linked answers.","properties":{"total":{"type":"number","description":"Total count of questions included in the aggregation."},"answers":{"type":"number","description":"Total count of answers linked to the questions."},"feedback":{"$ref":"#/components/schemas/SiteQuestionStatsFeedback"},"answered":{"$ref":"#/components/schemas/SiteQuestionStatsAnswered"},"relevance":{"$ref":"#/components/schemas/SiteQuestionStatsRelevance"},"types":{"$ref":"#/components/schemas/SiteQuestionStatsTypes"},"channelTypes":{"$ref":"#/components/schemas/SiteQuestionStatsChannelTypes"},"channels":{"$ref":"#/components/schemas/SiteQuestionStatsChannels"},"weeklyPulse":{"type":"array","minItems":13,"maxItems":13,"description":"Weekly count of related question answers for the past 3 months.","items":{"type":"number"}}},"required":["total","answers","feedback","answered","relevance","types","channelTypes","channels","weeklyPulse"]},"SiteQuestionStatsFeedback":{"type":"object","description":"Aggregated feedback for answers linked to a site question.","properties":{"positive":{"type":"number","description":"Count of answers with positive feedback."},"negative":{"type":"number","description":"Count of answers with negative feedback."},"unrated":{"type":"number","description":"Count of answers without feedback."}},"required":["positive","negative","unrated"]},"SiteQuestionStatsAnswered":{"type":"object","description":"Aggregated answered assessment for answers linked to a site question.","properties":{"yes":{"type":"number","description":"Count of answers assessed as fully answered."},"partially":{"type":"number","description":"Count of answers assessed as partially answered."},"no":{"type":"number","description":"Count of answers assessed as not answered."}},"required":["yes","partially","no"]},"SiteQuestionStatsRelevance":{"type":"object","properties":{"relevant":{"type":"number"},"spam":{"type":"number"},"off-topic":{"type":"number"},"unclear":{"type":"number"}},"required":["relevant","spam","off-topic","unclear"]},"SiteQuestionStatsTypes":{"type":"object","properties":{"exploring":{"type":"number"},"how-to":{"type":"number"},"troubleshooting":{"type":"number"},"reference":{"type":"number"},"unknown":{"type":"number"}},"required":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteQuestionStatsChannelTypes":{"type":"object","description":"Count of answers by site channel type, including core channels.","additionalProperties":{"type":"number"}},"SiteQuestionStatsChannels":{"type":"object","description":"Count of answers by site channel ID.","additionalProperties":{"type":"number"}}}}}
```

## The SiteQuestionAnswer object

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"components":{"schemas":{"SiteQuestionAnswer":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer"]},"id":{"type":"string","description":"The ID of the site question answer."},"question":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parent site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"}},"required":["id","type"]},"topics":{"type":"array","description":"The IDs of the associated site topics.","items":{"type":"string"}},"input":{"type":"object","required":["text","raw"],"properties":{"text":{"type":"string","description":"Normalized question text for this answer."},"raw":{"type":"string","description":"Raw question text as asked by the user."}}},"thread":{"type":"object","required":["id","previous"],"properties":{"id":{"type":"string","description":"The ID of the thread this answer belongs to."},"previous":{"type":"string","description":"ID of the previous answer in the same thread."}}},"session":{"$ref":"#/components/schemas/SiteInsightsSession"},"feedback":{"type":"object","required":["rating"],"properties":{"rating":{"type":"integer","enum":[-1,1],"description":"Feedback rating provided by the user."}}},"responseId":{"type":"string","description":"The response identifier for this answer."},"language":{"type":"string","description":"ISO language code of the question."},"answered":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"},"helpfulness":{"$ref":"#/components/schemas/SiteQuestionAnswerHelpfulness"},"relevance":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"},"channel":{"oneOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteCoreChannelType"}},"required":["type"]},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteConfigurableChannelType"},"id":{"type":["string","null"],"description":"ID of the associated site channel when the answer originates from a configurable channel. Null if the channel has been deleted."}},"required":["type","id"]}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","question","topics","input","responseId","language","answered","helpfulness","relevance","channel","createdAt","urls"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteInsightsSession":{"type":"object","description":"Identifiers for a GitBook site session, used for analytics and adaptive content.","properties":{"visitorId":{"type":"string","description":"GitBook's unique identifier of the visitor."},"sessionId":{"type":"string","description":"GitBook's unique identifier of the visitor's session."}},"required":["visitorId","sessionId"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"SiteQuestionAnswerHelpfulness":{"type":"string","description":"Helpfulness of the response for the end user need.","enum":["low","medium","high"]},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteCoreChannelType":{"type":"string","enum":["site","embed","api"]},"SiteConfigurableChannelType":{"type":"string","enum":["builtin:slack","builtin:discord","builtin:github"]},"Timestamp":{"type":"string","format":"date-time"}}}}
```

## The SiteQuestionAnswerWithResponse object

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"components":{"schemas":{"SiteQuestionAnswerWithResponse":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswer"},{"type":"object","properties":{"response":{"$ref":"#/components/schemas/AIMessage"}},"required":["response"]}]},"SiteQuestionAnswer":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer"]},"id":{"type":"string","description":"The ID of the site question answer."},"question":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parent site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"}},"required":["id","type"]},"topics":{"type":"array","description":"The IDs of the associated site topics.","items":{"type":"string"}},"input":{"type":"object","required":["text","raw"],"properties":{"text":{"type":"string","description":"Normalized question text for this answer."},"raw":{"type":"string","description":"Raw question text as asked by the user."}}},"thread":{"type":"object","required":["id","previous"],"properties":{"id":{"type":"string","description":"The ID of the thread this answer belongs to."},"previous":{"type":"string","description":"ID of the previous answer in the same thread."}}},"session":{"$ref":"#/components/schemas/SiteInsightsSession"},"feedback":{"type":"object","required":["rating"],"properties":{"rating":{"type":"integer","enum":[-1,1],"description":"Feedback rating provided by the user."}}},"responseId":{"type":"string","description":"The response identifier for this answer."},"language":{"type":"string","description":"ISO language code of the question."},"answered":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"},"helpfulness":{"$ref":"#/components/schemas/SiteQuestionAnswerHelpfulness"},"relevance":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"},"channel":{"oneOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteCoreChannelType"}},"required":["type"]},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteConfigurableChannelType"},"id":{"type":["string","null"],"description":"ID of the associated site channel when the answer originates from a configurable channel. Null if the channel has been deleted."}},"required":["type","id"]}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","question","topics","input","responseId","language","answered","helpfulness","relevance","channel","createdAt","urls"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteInsightsSession":{"type":"object","description":"Identifiers for a GitBook site session, used for analytics and adaptive content.","properties":{"visitorId":{"type":"string","description":"GitBook's unique identifier of the visitor."},"sessionId":{"type":"string","description":"GitBook's unique identifier of the visitor's session."}},"required":["visitorId","sessionId"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"SiteQuestionAnswerHelpfulness":{"type":"string","description":"Helpfulness of the response for the end user need.","enum":["low","medium","high"]},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteCoreChannelType":{"type":"string","enum":["site","embed","api"]},"SiteConfigurableChannelType":{"type":"string","enum":["builtin:slack","builtin:discord","builtin:github"]},"Timestamp":{"type":"string","format":"date-time"},"AIMessage":{"type":"object","properties":{"id":{"type":"string"},"role":{"$ref":"#/components/schemas/AIMessageRole"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AIMessageStep"}},"task":{"$ref":"#/components/schemas/AIMessageTask"},"response":{"$ref":"#/components/schemas/AIMessageResponseMetadata"}},"required":["id","role","steps"]},"AIMessageRole":{"type":"string","enum":["user","assistant"]},"AIMessageStep":{"type":"object","description":"A step in a message from the AI agent.","properties":{"content":{"$ref":"#/components/schemas/JSONDocument"},"reasoning":{"$ref":"#/components/schemas/JSONDocument"},"toolCalls":{"type":"array","items":{"$ref":"#/components/schemas/AIToolCall"}},"timing":{"type":"object","description":"The timing of the step.","properties":{"reasoning":{"$ref":"#/components/schemas/Timerange"}}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AIAttachment"}}},"required":["content"]},"JSONDocument":{"type":"object","properties":{"object":{"type":"string","enum":["document"]},"data":{"type":"object","properties":{"schemaVersion":{"description":"The schema version of the document. If undefined, the document is considered to be of the latest schema version.","type":"integer"}},"additionalProperties":true},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksTopLevels"}},"meta":{"type":"object","properties":{"token":{"description":"A content token that can be used to fetch the content referenced in this document from the API.","type":"string"}}}},"required":["object","data","nodes"]},"DocumentBlocksTopLevels":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockOpenAPI"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIOperation"},{"$ref":"#/components/schemas/DocumentBlockOpenAPISchemas"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIWebhook"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockStepper"},{"$ref":"#/components/schemas/DocumentBlockIf"},{"$ref":"#/components/schemas/DocumentBlockColumns"}]},"DocumentBlocksEssentials":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockParagraph"},{"$ref":"#/components/schemas/DocumentBlockHeading"},{"$ref":"#/components/schemas/DocumentBlockListOrdered"},{"$ref":"#/components/schemas/DocumentBlockListUnordered"},{"$ref":"#/components/schemas/DocumentBlockListTasks"},{"$ref":"#/components/schemas/DocumentBlockDivider"}]},"DocumentBlockParagraph":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["paragraph"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentInline"},{"$ref":"#/components/schemas/DocumentText"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"align":{"$ref":"#/components/schemas/TextAlignment"}},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentInline":{"oneOf":[{"$ref":"#/components/schemas/DocumentInlineLink"},{"$ref":"#/components/schemas/DocumentInlineEmoji"},{"$ref":"#/components/schemas/DocumentInlineIcon"},{"$ref":"#/components/schemas/DocumentInlineExpression"},{"$ref":"#/components/schemas/DocumentInlineMath"},{"$ref":"#/components/schemas/DocumentInlineImage"},{"$ref":"#/components/schemas/DocumentInlineAnnotation"},{"$ref":"#/components/schemas/DocumentInlineMention"},{"$ref":"#/components/schemas/DocumentInlineButton"}]},"DocumentInlineLink":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["link"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentText"},{"$ref":"#/components/schemas/DocumentInlineImage"}]}},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentText":{"type":"object","properties":{"object":{"type":"string","enum":["text"]},"key":{"type":"string"},"leaves":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTextLeaf"}}},"required":["object","leaves"]},"DocumentTextLeaf":{"type":"object","properties":{"object":{"type":"string","enum":["leaf"]},"text":{"type":"string"},"marks":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTextMark"}}},"required":["object","text","marks"]},"DocumentTextMark":{"oneOf":[{"$ref":"#/components/schemas/DocumentMarkBold"},{"$ref":"#/components/schemas/DocumentMarkItalic"},{"$ref":"#/components/schemas/DocumentMarkCode"},{"$ref":"#/components/schemas/DocumentMarkKeyboard"},{"$ref":"#/components/schemas/DocumentMarkStrikethrough"},{"$ref":"#/components/schemas/DocumentMarkColor"},{"$ref":"#/components/schemas/DocumentMarkSuperscript"},{"$ref":"#/components/schemas/DocumentMarkSubscript"}]},"DocumentMarkBold":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["bold"]}},"required":["object","type"]},"DocumentMarkItalic":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["italic"]}},"required":["object","type"]},"DocumentMarkCode":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["code"]}},"required":["object","type"]},"DocumentMarkKeyboard":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["keyboard"]}},"required":["object","type"]},"DocumentMarkStrikethrough":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["strikethrough"]}},"required":["object","type"]},"DocumentMarkColor":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["color"]},"data":{"type":"object","properties":{"text":{"$ref":"#/components/schemas/DocumentTextColor"},"background":{"$ref":"#/components/schemas/DocumentTextColor"}},"required":["text","background"]}},"required":["object","type","data"]},"DocumentTextColor":{"type":"string","enum":["default","green","blue","red","orange","yellow","purple","$primary","$info","$success","$warning","$danger"]},"DocumentMarkSuperscript":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["superscript"]}},"required":["object","type"]},"DocumentMarkSubscript":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["subscript"]}},"required":["object","type"]},"DocumentInlineImage":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["inline-image"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"refDark":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"caption":{"type":"string"},"alt":{"type":"string"},"size":{"type":"string","enum":["original","line"]}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefTag"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefTag":{"type":"object","properties":{"kind":{"type":"string","enum":["tag"]},"tag":{"type":"string","description":"The slug of the tag, also used as the ID, and references the tags defined on a revision."},"space":{"type":"string","description":"The space in which the tag is defined. If undefined, the tag is assumed to be in the same space as the content reference."}},"required":["kind","tag"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"DocumentInlineEmoji":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["emoji"]},"key":{"type":"string"},"data":{"type":"object","properties":{"code":{"type":"string"}},"required":["code"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineIcon":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["icon"]},"key":{"type":"string"},"data":{"type":"object","properties":{"icon":{"type":"string"},"color":{"$ref":"#/components/schemas/DocumentTextColor"}},"required":["icon"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineExpression":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["expression"]},"key":{"type":"string"},"data":{"type":"object","properties":{"expression":{"type":"string"}},"required":["expression"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineMath":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["inline-math"]},"key":{"type":"string"},"data":{"type":"object","properties":{"formula":{"type":"string"}},"required":["formula"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineAnnotation":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["annotation"]},"key":{"type":"string"},"fragments":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"type":{"type":"string","enum":["annotation-body"]},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockCode"}]},"minItems":1}},"required":["nodes","type"]}]}},"isVoid":{"type":"boolean","enum":[false]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentText"}},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","fragments","isVoid","nodes"]},"DocumentFragment":{"type":"object","properties":{"object":{"type":"string","enum":["fragment"]},"key":{"type":"string"},"fragment":{"type":"string"},"type":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlock"}}},"required":["object","nodes"]},"DocumentBlock":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockParagraph"},{"$ref":"#/components/schemas/DocumentBlockHeading"},{"$ref":"#/components/schemas/DocumentBlockListOrdered"},{"$ref":"#/components/schemas/DocumentBlockListUnordered"},{"$ref":"#/components/schemas/DocumentBlockListTasks"},{"$ref":"#/components/schemas/DocumentBlockListItem"},{"$ref":"#/components/schemas/DocumentBlockDivider"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockIf"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockImage"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockCodeLine"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockTabsItem"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockOpenAPI"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIOperation"},{"$ref":"#/components/schemas/DocumentBlockOpenAPISchemas"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIWebhook"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockStepper"},{"$ref":"#/components/schemas/DocumentBlockStepperStep"},{"$ref":"#/components/schemas/DocumentBlockColumns"},{"$ref":"#/components/schemas/DocumentBlockColumn"},{"$ref":"#/components/schemas/DocumentBlockUpdates"},{"$ref":"#/components/schemas/DocumentBlockUpdate"}]},"DocumentBlockHeading":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["heading-1","heading-2","heading-3"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentInline"},{"$ref":"#/components/schemas/DocumentText"}]}},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^[-a-z0-9.+_]+$"},"align":{"$ref":"#/components/schemas/TextAlignment"}}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"TextAlignment":{"type":"string","enum":["start","center","end"]},"DocumentBlockListOrdered":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-ordered"]},"key":{"type":"string"},"data":{"type":"object","properties":{"start":{"type":"number","description":"An integer to start counting from for the list items."}}},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"DocumentBlockListItem":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-item"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockTable"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"checked":{"type":"boolean"}}}},"required":["object","type","nodes"]},"DocumentBlockCode":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["code"]},"key":{"type":"string"},"data":{"type":"object","properties":{"syntax":{"type":"string"},"title":{"type":"string"},"overflow":{"type":"string","default":"scroll","enum":["scroll","wrap"]},"lineNumbers":{"type":"boolean"},"fullWidth":{"type":"boolean"},"expandable":{"type":"boolean"},"collapsedLineCount":{"type":"integer","description":"Number of lines rendered in a code block when it is collapsed","minimum":1,"default":10}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockCodeLine"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"DocumentBlockCodeLine":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["code-line"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentText"},{"$ref":"#/components/schemas/DocumentInlineAnnotation"},{"$ref":"#/components/schemas/DocumentInlineExpression"}]}},"data":{"type":"object","properties":{"highlighted":{"type":"boolean"}}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockHint":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["hint"]},"key":{"type":"string"},"data":{"type":"object","properties":{"style":{"type":"string","enum":["info","warning","danger","success"]},"icon":{"$ref":"#/components/schemas/Icon"}},"required":["style"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksEssentials"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"Icon":{"type":"string","maxLength":50,"format":"icon","description":"Name of the icon"},"DocumentBlockQuote":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["blockquote"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockQuote"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockMath":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["math"]},"key":{"type":"string"},"data":{"type":"object","properties":{"formula":{"type":"string"}},"required":["formula"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockTable":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["table"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"view":{"oneOf":[{"$ref":"#/components/schemas/DocumentTableViewGrid"},{"$ref":"#/components/schemas/DocumentTableViewCards"}]},"records":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentTableRecord"}},"definition":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentTableDefinition"}},"fullWidth":{"type":"boolean","description":"Whether to render the block as a full width one"}},"required":["view","records","definition"]},"fragments":{"type":"array","items":{"$ref":"#/components/schemas/DocumentFragment"}}},"required":["object","type","data","isVoid","fragments"]},"DocumentTableViewGrid":{"type":"object","properties":{"type":{"type":"string","enum":["grid"]},"columns":{"type":"array","description":"Ordered list of the definition IDs to display","items":{"type":"string"}},"columnWidths":{"type":"object","description":"Percent width of each column","additionalProperties":{"type":"number"}},"hideHeader":{"type":"boolean","description":"Should we display the header with column titles"},"stickyHeader":{"type":"boolean","description":"Should we keep the table header sticky while the page scrolls"},"useNewSizing":{"type":"boolean","description":"Tables in GitBook originally used a scaled width approach i.e. the width defined\nin columnWidths would be scaled to ensure a 100% width table.\n\nWe later changed this to treat the widths in columnWidths as exact values - they are\nnever scaled. A columnWidth of 50 is rendered as 50px.\n\nIn order to maintain backwards compatibility, we track whether or not we\nuse the new system here.\n\nAll new tables should have this value set to true, older tables will have it set\nto undefined.\n"}},"required":["type","columns","hideHeader"]},"DocumentTableViewCards":{"type":"object","properties":{"type":{"type":"string","enum":["cards"]},"cardSize":{"type":"string","description":"Size of the cards. It indicates how many columns will be used","enum":["medium","large"]},"columns":{"type":"array","description":"Ordered list of the definition IDs to display","items":{"type":"string"}},"targetDefinition":{"type":"string","description":"Definition ID to use as a target link for the card"},"coverDefinition":{"type":"string","description":"Definition ID to use as a cover image"},"coverDefinitionDark":{"type":"string","description":"Definition ID to use as a dark mode cover image"},"hideColumnTitle":{"type":"boolean","description":"Should we display the column title or not"}},"required":["type","columns","cardSize"]},"DocumentTableRecord":{"type":"object","properties":{"orderIndex":{"type":"string"},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"number"},{"type":["string","null"]},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/ContentRef"},{"$ref":"#/components/schemas/DocumentTableImageRecord"}]}}},"required":["orderIndex","values"]},"DocumentTableImageRecord":{"description":"A table record value for image columns, supporting both direct ContentRefs and the additional format with record-level settings.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"}]},"objectFit":{"$ref":"#/components/schemas/CardsImageObjectFit"},"alt":{"type":"string","description":"Alternative text for the cover image"}},"required":["ref"]}]},"CardsImageObjectFit":{"type":"string","description":"Object fit for image display in card views","enum":["contain","fill","cover"]},"DocumentTableDefinition":{"oneOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionText"},{"$ref":"#/components/schemas/DocumentTableDefinitionNumber"},{"$ref":"#/components/schemas/DocumentTableDefinitionCheckbox"},{"$ref":"#/components/schemas/DocumentTableDefinitionFiles"},{"$ref":"#/components/schemas/DocumentTableDefinitionUsers"},{"$ref":"#/components/schemas/DocumentTableDefinitionRating"},{"$ref":"#/components/schemas/DocumentTableDefinitionSelect"},{"$ref":"#/components/schemas/DocumentTableDefinitionContentRef"},{"$ref":"#/components/schemas/DocumentTableDefinitionImage"}]},"DocumentTableDefinitionText":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"textAlignment":{"type":"string","enum":["center","right","left"]},"verticalAlignment":{"$ref":"#/components/schemas/VerticalAlignment"}},"required":["type","textAlignment"]}]},"DocumentTableDefinitionBase":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","description":"Title for the column"}},"required":["id","title"]},"VerticalAlignment":{"type":"string","enum":["top","middle","bottom"]},"DocumentTableDefinitionNumber":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["number"]}},"required":["type"]}]},"DocumentTableDefinitionCheckbox":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["checkbox"]}},"required":["type"]}]},"DocumentTableDefinitionFiles":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["files"]}},"required":["type"]}]},"DocumentTableDefinitionUsers":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"multiple":{"type":"boolean"}},"required":["type","multiple"]}]},"DocumentTableDefinitionRating":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["rating"]},"max":{"type":"number"}},"required":["type","max"]}]},"DocumentTableDefinitionSelect":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["select"]},"multiple":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTableSelectOption"}}},"required":["type","multiple","options"]}]},"DocumentTableSelectOption":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"color":{"type":"string"}},"required":["value","label","color"]},"DocumentTableDefinitionContentRef":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["content-ref"]}},"required":["type"]}]},"DocumentTableDefinitionImage":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["image"]}},"required":["type"]}]},"DocumentBlockListUnordered":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-unordered"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"data":{"type":"object","additionalProperties":false},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes"]},"DocumentBlockListTasks":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-tasks"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockDivider":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["divider"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","isVoid","data"]},"DocumentBlockIf":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["if"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksTopLevels"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"expression":{"type":"string"}},"required":["expression"]}},"required":["object","type","nodes","data"]},"DocumentBlockImages":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["images"]},"key":{"type":"string"},"data":{"type":"object","properties":{"align":{"type":"string","enum":["center","left","right"]},"fullWidth":{"type":"boolean"},"withFrame":{"type":"boolean"}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockImage"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes","isVoid"]},"DocumentBlockImage":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["image"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"refDark":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"width":{"$ref":"#/components/schemas/Length"},"height":{"$ref":"#/components/schemas/Length"},"alt":{"type":"string"}},"required":["ref"]},"fragments":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["caption"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockParagraph"}}},"required":["nodes","fragment"]}]}},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","fragments","isVoid"]},"Length":{"oneOf":[{"type":"number"},{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["unit","value"]}]},"DocumentBlockFile":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["file"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"}]}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockDrawing":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["drawing"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"}]}}},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockEmbed":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["embed"]},"key":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"fullWidth":{"type":"boolean"}},"required":["url"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockExpandable":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["expandable"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"defaultExpanded":{"type":"boolean"}},"additionalProperties":false},"fragments":{"type":"array","items":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["expandable-title"]},"type":{"type":"string","enum":["expandable-title"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockParagraph"},"minItems":1,"maxItems":1}},"required":["nodes","fragment","type"]}]},{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["expandable-body"]},"type":{"type":"string","enum":["expandable-body"]},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockIntegration"}]},"minItems":1}},"required":["nodes","fragment","type"]}]}]}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","isVoid","fragments","data"]},"DocumentBlockReusableContent":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["reusable-content"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefReusableContent"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"token":{"description":"A content token that can be used to fetch the reusable content from the API.","type":"string"}}}},"required":["object","type","data","isVoid"]},"DocumentBlockIntegration":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["integration"]},"key":{"type":"string"},"data":{"type":"object","properties":{"integration":{"type":"string","description":"Name of the integration"},"block":{"type":"string","description":"ID of the block in the integration"},"props":{"description":"Properties passed to the block during rendering","$ref":"#/components/schemas/PlainObject"},"action":{"$ref":"#/components/schemas/ContentKitAction"},"url":{"type":"string","description":"URL associated with the content represented by the block.\nThis property is set when creating a block from a URL (unfurl) to ensure\nwe can convert the block back to an embed.\n"},"fullWidth":{"type":"boolean"}},"required":["integration","block","props"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"PlainObject":{"properties":{},"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/PlainObject"},{"type":"string"},{"type":"boolean"},{"type":"number"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"},{"$ref":"#/components/schemas/PlainObject"}]}}]}},"ContentKitAction":{"anyOf":[{"type":"object","description":"Custom action to re-render the block.","properties":{"action":{"type":"string"}},"additionalProperties":true,"required":["action"]},{"$ref":"#/components/schemas/ContentKitDefaultAction"}]},"ContentKitDefaultAction":{"oneOf":[{"type":"object","description":"Action to open an overlay modal defined by \"componentId\".","properties":{"action":{"type":"string","enum":["@ui.modal.open"]},"componentId":{"type":"string"},"props":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","componentId","props"]},{"type":"object","description":"Action when a modal overlay is closed, with a return value to the higher level component in the stack. This action will be triggered on the parent component instance.","properties":{"action":{"type":"string","enum":["@ui.modal.close"]},"returnValue":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","returnValue"]},{"type":"object","description":"Action to open an url.","properties":{"action":{"type":"string","enum":["@ui.url.open"]},"url":{"type":"string"}},"required":["action","url"]},{"type":"object","description":"Action when a link is being unfurled into a block.","properties":{"action":{"type":"string","enum":["@link.unfurl"]},"url":{"type":"string"}},"required":["action","url"]},{"type":"object","description":"Action to update the properties stored in the related node.","properties":{"action":{"type":"string","enum":["@editor.node.updateProps"]},"props":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","props"]}]},"DocumentBlockTabs":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["tabs"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockTabsItem"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"fullWidth":{"type":"boolean"}},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockTabsItem":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["tabs-item"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"}]}},"data":{"type":"object","properties":{"title":{"type":"string"}}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockContentRef":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["content-ref"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockOpenAPI":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["swagger"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIOperationPointer"},{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"}]},"expanded":{"type":"boolean","description":"If true, the block is opened by default."},"fullWidth":{"type":"boolean"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPIOperationPointer":{"type":"object","description":"Pointer to an operation in the OpenAPI spec.","properties":{"path":{"type":"string","description":"Path of the operation in the OpenAPI spec."},"method":{"type":"string","description":"HTTP method of the operation in the OpenAPI spec."}},"required":["path","method"]},"DocumentBlockOpenAPIOperation":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-operation"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIOperationPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"DocumentBlockOpenAPISchemas":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-schemas"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPISchemasPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}],"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPISchemasPointer":{"type":"object","description":"Pointer to schemas in the OpenAPI spec.","properties":{"grouped":{"type":"boolean","description":"Whether the schemas are grouped or not.","default":true},"schemas":{"type":"array","description":"List of schemas name from the OpenAPI spec.","items":{"type":"string"}},"title":{"type":"string","description":"Custom title for the schemas block. When not provided, defaults to \"The <SchemaName> object\"."}},"required":["schemas"]},"DocumentBlockOpenAPIWebhook":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-webhook"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIWebhookPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPIWebhookPointer":{"type":"object","description":"Pointer to a webhook in the OpenAPI spec.","properties":{"name":{"type":"string","description":"Name of the webhook in the OpenAPI spec."},"method":{"type":"string","description":"HTTP method of the webhook in the OpenAPI spec."}},"required":["name","method"]},"DocumentBlockStepper":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["stepper"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockStepperStep"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockStepperStep":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["stepper-step"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockExpandable"}]}},"data":{"type":"object","properties":{"icon":{"type":"string"}}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockColumns":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["columns"]},"key":{"type":"string"},"data":{"type":"object","properties":{"fullWidth":{"type":"boolean"}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockColumn"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes","isVoid"]},"DocumentBlockColumn":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["column"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockStepper"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"width":{"$ref":"#/components/schemas/Length"},"verticalAlignment":{"$ref":"#/components/schemas/VerticalAlignment"}},"additionalProperties":false}},"required":["object","type","nodes","data"]},"DocumentBlockUpdates":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["updates"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockUpdate"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"format":{"type":"string","enum":["numeric","full","short"],"default":"full"}},"required":["format"],"additionalProperties":false}},"required":["object","type","nodes","data"]},"DocumentBlockUpdate":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["update"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockExpandable"}]}},"data":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/Timestamp"},"tags":{"type":"array","description":"Array of tags. Each tag is id'ed by its slug.","items":{"$ref":"#/components/schemas/ContentRefTag"}}},"required":["date"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentInlineMention":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["mention"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineButton":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["button"]},"key":{"type":"string"},"data":{"allOf":[{"type":"object","properties":{"label":{"type":"string"},"kind":{"type":"string","enum":["primary","secondary"]},"icon":{"$ref":"#/components/schemas/Icon"}},"required":["label","kind"]},{"oneOf":[{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"],"additionalProperties":false},{"type":"object","properties":{"action":{"$ref":"#/components/schemas/DocumentAction"}},"required":["action"],"additionalProperties":false}]}]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentAction":{"type":"object","oneOf":[{"type":"object","properties":{"action":{"type":"string","enum":["search"]},"query":{"type":"string"}},"required":["action"],"additionalProperties":false},{"type":"object","properties":{"action":{"type":"string","enum":["ask"]},"query":{"type":"string"}},"required":["action"],"additionalProperties":false}]},"AIToolCall":{"oneOf":[{"$ref":"#/components/schemas/AIToolCallGetPageContent"},{"$ref":"#/components/schemas/AIToolCallGetRecordContent"},{"$ref":"#/components/schemas/AIToolCallGetPages"},{"$ref":"#/components/schemas/AIToolCallGetReusableContents"},{"$ref":"#/components/schemas/AIToolCallSearch"},{"$ref":"#/components/schemas/AIToolCallEditPage"},{"$ref":"#/components/schemas/AIToolCallCreatePage"},{"$ref":"#/components/schemas/AIToolCallDeletePage"},{"$ref":"#/components/schemas/AIToolCallRenamePage"},{"$ref":"#/components/schemas/AIToolCallMovePage"},{"$ref":"#/components/schemas/AIToolCallListModifiedPages"},{"$ref":"#/components/schemas/AIToolCallGetPageDiff"},{"$ref":"#/components/schemas/AIToolCallCreateReusableContent"},{"$ref":"#/components/schemas/AIToolCallEditReusableContent"},{"$ref":"#/components/schemas/AIToolCallGetReusableContent"},{"$ref":"#/components/schemas/AIToolCallCreateChangeRequest"},{"$ref":"#/components/schemas/AIToolCallComment"},{"$ref":"#/components/schemas/AIToolCallReplyToComment"},{"$ref":"#/components/schemas/AIToolCallSubmitChangeRequestReview"},{"$ref":"#/components/schemas/AIToolCallMCP"},{"$ref":"#/components/schemas/AIToolCallOther"}]},"AIToolCallGetPageContent":{"type":"object","properties":{"tool":{"type":"string","enum":["getPageContent"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The ID of the revision within which the page content is being fetched."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page","revisionId"]},"ChangedRevisionPage":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/RevisionPageType"},"title":{"type":"string"},"path":{"type":"string"}},"required":["id","type","title"]},"RevisionPageType":{"type":"string","enum":["document","group","link","computed"]},"AIToolCallGetRecordContent":{"type":"object","description":"Tool to read the body of an external record.","properties":{"tool":{"type":"string","enum":["getRecordContent"]},"siteId":{"type":"string","description":"The ID of the site owning the context record."},"recordId":{"type":"string","description":"The ID of the context record."},"title":{"type":"string","description":"The title of the record."},"url":{"type":"string","format":"uri","description":"URL of the record in the source system."}},"required":["tool","siteId","recordId","title"]},"AIToolCallGetPages":{"type":"object","properties":{"tool":{"type":"string","enum":["getPages"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The revision ID of the space."}},"required":["tool","spaceId","revisionId"]},"AIToolCallGetReusableContents":{"type":"object","properties":{"tool":{"type":"string","enum":["getReusableContents"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The revision ID of the space."}},"required":["tool","spaceId","revisionId"]},"AIToolCallSearch":{"type":"object","description":"Tool to search for content","properties":{"tool":{"type":"string","enum":["search"]},"query":{"type":"string","description":"The query that has been searched for."},"results":{"type":"array","items":{"$ref":"#/components/schemas/AIToolCallSearchResult"}}},"required":["tool","query","results"]},"AIToolCallSearchResult":{"description":"Result of a search","oneOf":[{"$ref":"#/components/schemas/AIToolCallSearchResultPage"},{"$ref":"#/components/schemas/AIToolCallSearchResultRecord"}],"discriminator":{"propertyName":"type"}},"AIToolCallSearchResultPage":{"type":"object","title":"Page result","description":"Result of a search matching a page.","properties":{"type":{"type":"string","enum":["page"]},"spaceId":{"type":"string","description":"The ID of the space"},"pageId":{"type":"string","description":"The ID of the page"},"revisionId":{"type":"string","description":"The revision ID of the result"},"anchor":{"type":"string","description":"The anchor of the result"},"title":{"type":"string","description":"The title of the result"},"description":{"type":"string","description":"The description of the result"}},"required":["type","spaceId","pageId","revisionId","title"]},"AIToolCallSearchResultRecord":{"type":"object","title":"Site context record result","description":"Result of a search matching a site context record.","properties":{"type":{"type":"string","enum":["record"]},"siteId":{"type":"string","description":"The ID of the site owning the context record"},"recordId":{"type":"string","description":"The ID of the context record"},"title":{"type":"string","description":"The title of the record"},"description":{"type":"string","description":"The description of the record"},"url":{"type":"string","format":"uri","description":"URL of the record in its original source"}},"required":["type","siteId","recordId","title"]},"AIToolCallEditPage":{"type":"object","properties":{"tool":{"type":"string","enum":["editPage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallCreatePage":{"type":"object","properties":{"tool":{"type":"string","enum":["createPage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallDeletePage":{"type":"object","properties":{"tool":{"type":"string","enum":["deletePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallRenamePage":{"type":"object","properties":{"tool":{"type":"string","enum":["renamePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"},"title":{"type":"string","description":"The new title of the page."}},"required":["tool","spaceId","page","title"]},"AIToolCallMovePage":{"type":"object","properties":{"tool":{"type":"string","enum":["movePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"},"to":{"$ref":"#/components/schemas/ChangedRevisionPage"},"moveType":{"type":"string","description":"Indicates how the page was moved relative to the \"to\" page.\n- `within`: moved as the last child of the target page (or to the root when `to` is omitted)\n- `before`: moved directly before the target page\n- `after`: moved directly after the target page\n","enum":["within","before","after"]}},"required":["tool","spaceId","page","moveType"]},"AIToolCallListModifiedPages":{"type":"object","properties":{"tool":{"type":"string","enum":["listModifiedPages"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."}},"required":["tool","spaceId"]},"AIToolCallGetPageDiff":{"type":"object","properties":{"tool":{"type":"string","enum":["getPageDiff"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallCreateReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["createReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent"]},"ChangedRevisionReusableContent":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"document":{"type":"string"}},"required":["id","title"]},"AIToolCallEditReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["editReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent"]},"AIToolCallGetReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["getReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The ID of the revision within which the reusable content is being fetched."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent","revisionId"]},"AIToolCallCreateChangeRequest":{"type":"object","properties":{"tool":{"type":"string","enum":["createChangeRequest"]},"spaceId":{"type":"string","description":"The ID of the space the change request belongs to."},"action":{"type":"string","enum":["create","update"]},"changeRequest":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the change request."},"number":{"type":"number","description":"Incremental identifier of the change request."},"subject":{"type":"string","description":"A brief summary of the change request."}},"required":["id","number","subject"]}},"required":["tool","spaceId","action","changeRequest"]},"AIToolCallComment":{"type":"object","properties":{"tool":{"type":"string","enum":["comment"]},"spaceId":{"type":"string","description":"The ID of the space being commented."},"page":{"description":"The page being commented.","$ref":"#/components/schemas/ChangedRevisionPage"},"commentId":{"type":"string","description":"The ID of the comment being posted."}},"required":["tool","spaceId","commentId"]},"AIToolCallReplyToComment":{"type":"object","properties":{"tool":{"type":"string","enum":["replyToComment"]},"spaceId":{"type":"string","description":"The ID of the space being commented."},"page":{"description":"The page being commented.","$ref":"#/components/schemas/ChangedRevisionPage"},"commentId":{"type":"string","description":"The ID of the comment being replied to."},"replyId":{"type":"string","description":"The ID of the reply being posted."}},"required":["tool","spaceId","commentId","replyId"]},"AIToolCallSubmitChangeRequestReview":{"type":"object","properties":{"tool":{"type":"string","enum":["submitChangeRequestReview"]},"spaceId":{"type":"string","description":"The ID of the space where the review was submitted."},"changeRequestId":{"type":"string","description":"The ID of the change request being reviewed."},"status":{"$ref":"#/components/schemas/ChangeRequestReviewStatus","description":"Result of the review."},"reviewId":{"type":"string","description":"Identifier of the review that was created."},"commentId":{"type":"string","description":"Identifier of the comment that was created as part of the review."}},"required":["tool","spaceId","changeRequestId","status","reviewId","commentId"]},"ChangeRequestReviewStatus":{"type":"string","description":"Status of a change request review.","enum":["changes-requested","approved"]},"AIToolCallMCP":{"type":"object","description":"Tool called from an MCP server","properties":{"tool":{"type":"string","enum":["mcp"]},"mcpServerId":{"type":"string","description":"The ID of the MCP server that has been called."},"mcpToolName":{"type":"string","description":"The name of the tool that has been called."},"mcpToolTitle":{"type":"string","description":"The title of the tool that has been called."}},"required":["tool","mcpServerId","mcpToolName"]},"AIToolCallOther":{"type":"object","description":"Any tool call that is unknown by GitBook","properties":{"tool":{"type":"string","enum":["other"]},"summary":{"$ref":"#/components/schemas/AIToolCallOtherSummary"}},"required":["tool","summary"]},"AIToolCallOtherSummary":{"type":"object","description":"Summary of a generic tool call.","properties":{"icon":{"$ref":"#/components/schemas/Icon"},"text":{"type":"string","description":"Text to display to the user to describe the tool call."}},"required":["icon","text"]},"Timerange":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"end":{"$ref":"#/components/schemas/Timestamp"}},"required":["start","end"]},"AIAttachment":{"oneOf":[{"$ref":"#/components/schemas/AIAttachmentImage"},{"$ref":"#/components/schemas/AIAttachmentFile"}]},"AIAttachmentImage":{"type":"object","properties":{"type":{"type":"string","enum":["image"]},"url":{"$ref":"#/components/schemas/URL"}},"required":["type","url"]},"URL":{"type":"string","format":"uri","maxLength":2048},"AIAttachmentFile":{"type":"object","properties":{"type":{"type":"string","enum":["file"]},"url":{"$ref":"#/components/schemas/URL"},"filename":{"type":"string","description":"Name of the file."},"contentType":{"type":"string","enum":["application/pdf"]}},"required":["type","url","filename","contentType"]},"AIMessageTask":{"oneOf":[{"type":"object","description":"When the agent is responding to a comment.","properties":{"type":{"type":"string","enum":["respond_to_comment"]},"spaceId":{"type":"string","description":"The ID of the space to respond to the comment in."},"changeRequestId":{"type":"string","description":"The ID of the change request to respond to the comment in."},"commentId":{"type":"string","description":"The ID of the comment to respond to."}},"required":["type","spaceId","commentId"]},{"type":"object","description":"When the agent is reviewing a change request.","properties":{"type":{"type":"string","enum":["review_change_request"]},"spaceId":{"type":"string","description":"The ID of the space the change request is in."},"changeRequestId":{"type":"string","description":"The ID of the change request to review."}},"required":["type","spaceId","changeRequestId"]},{"type":"object","description":"When the agent is implementing a task in a change request.","properties":{"type":{"type":"string","enum":["implement_change_request"]},"spaceId":{"type":"string","description":"The ID of the space the change request is in."},"changeRequestId":{"type":"string","description":"The ID of the change request to implement the task in."}},"required":["type","spaceId","changeRequestId"]}]},"AIMessageResponseMetadata":{"description":"The response that generated this message.","type":"object","properties":{"stopReason":{"type":"string","description":"The reason the response was stopped. If not defined, the response finished normally.","enum":["aborted"]},"id":{"type":"string","description":"The ID of the response that generated this message. It can be undefined if the stream was aborted."},"previous":{"type":"string","description":"The ID of the previous response that this message is based on."}}}}}}
```

## The SiteQuestionAnswerSource object

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"components":{"schemas":{"SiteQuestionAnswerSource":{"oneOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourcePage"},{"$ref":"#/components/schemas/SiteQuestionAnswerSourceRecord"}],"discriminator":{"propertyName":"type"}},"SiteQuestionAnswerSourcePage":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourceBase"},{"type":"object","title":"Page source","description":"Source data pointing to a page used for a site question answer.","properties":{"type":{"type":"string","enum":["page"]},"space":{"type":"string","description":"The space ID of the source page."},"revision":{"type":"string","description":"The revision ID used for this source page."},"page":{"type":"string","description":"The page ID of the source page."}},"required":["type","space","revision","page"]}]},"SiteQuestionAnswerSourceBase":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer-source"]},"id":{"type":"string","description":"The ID of the source."},"weight":{"type":"number","description":"Relative weight of this source in the generated answer."},"title":{"type":"string","description":"The title of the source."},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","title","weight","urls"]},"SiteQuestionAnswerSourceRecord":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourceBase"},{"type":"object","properties":{"type":{"type":"string","enum":["record"]},"record":{"type":"string","description":"The site context record ID."},"connector":{"$ref":"#/components/schemas/ContextConnector"}},"required":["type","record"]}]},"ContextConnector":{"oneOf":[{"type":"string","description":"Integration source","pattern":"^integration:[^:]+$"},{"type":"string","description":"Builtin sources","enum":["builtin:email","builtin:api","builtin:website","builtin:youtube","builtin:github-discussions","builtin:github-issues","builtin:intercom"]}]}}}}
```

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

> List all questions in a site

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"listOrder":{"name":"order","in":"query","description":"An order for the items in the list","schema":{"type":"string","default":"desc","enum":["asc","desc"]}},"listPage":{"name":"page","in":"query","description":"Identifier of the page results to fetch.","schema":{"type":"string"}},"listLimit":{"name":"limit","in":"query","description":"The number of results per page","schema":{"type":"number","minimum":0,"maximum":1000}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"Timestamp":{"type":"string","format":"date-time"},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"SiteQuestion":{"type":"object","properties":{"object":{"type":"string","enum":["site-question"]},"id":{"type":"string","description":"The ID of the site question."},"question":{"type":"string","description":"Canonical text for the unique site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"askedAt":{"$ref":"#/components/schemas/Timestamp"},"stats":{"$ref":"#/components/schemas/SiteQuestionStats"},"urls":{"type":"object","description":"URLs associated with the site question.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question in the API."}},"required":["location"]}},"required":["object","id","question","type","createdAt","askedAt","stats","urls"]},"SiteQuestionStats":{"type":"object","description":"Aggregated stats for questions and linked answers.","properties":{"total":{"type":"number","description":"Total count of questions included in the aggregation."},"answers":{"type":"number","description":"Total count of answers linked to the questions."},"feedback":{"$ref":"#/components/schemas/SiteQuestionStatsFeedback"},"answered":{"$ref":"#/components/schemas/SiteQuestionStatsAnswered"},"relevance":{"$ref":"#/components/schemas/SiteQuestionStatsRelevance"},"types":{"$ref":"#/components/schemas/SiteQuestionStatsTypes"},"channelTypes":{"$ref":"#/components/schemas/SiteQuestionStatsChannelTypes"},"channels":{"$ref":"#/components/schemas/SiteQuestionStatsChannels"},"weeklyPulse":{"type":"array","minItems":13,"maxItems":13,"description":"Weekly count of related question answers for the past 3 months.","items":{"type":"number"}}},"required":["total","answers","feedback","answered","relevance","types","channelTypes","channels","weeklyPulse"]},"SiteQuestionStatsFeedback":{"type":"object","description":"Aggregated feedback for answers linked to a site question.","properties":{"positive":{"type":"number","description":"Count of answers with positive feedback."},"negative":{"type":"number","description":"Count of answers with negative feedback."},"unrated":{"type":"number","description":"Count of answers without feedback."}},"required":["positive","negative","unrated"]},"SiteQuestionStatsAnswered":{"type":"object","description":"Aggregated answered assessment for answers linked to a site question.","properties":{"yes":{"type":"number","description":"Count of answers assessed as fully answered."},"partially":{"type":"number","description":"Count of answers assessed as partially answered."},"no":{"type":"number","description":"Count of answers assessed as not answered."}},"required":["yes","partially","no"]},"SiteQuestionStatsRelevance":{"type":"object","properties":{"relevant":{"type":"number"},"spam":{"type":"number"},"off-topic":{"type":"number"},"unclear":{"type":"number"}},"required":["relevant","spam","off-topic","unclear"]},"SiteQuestionStatsTypes":{"type":"object","properties":{"exploring":{"type":"number"},"how-to":{"type":"number"},"troubleshooting":{"type":"number"},"reference":{"type":"number"},"unknown":{"type":"number"}},"required":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteQuestionStatsChannelTypes":{"type":"object","description":"Count of answers by site channel type, including core channels.","additionalProperties":{"type":"number"}},"SiteQuestionStatsChannels":{"type":"object","description":"Count of answers by site channel ID.","additionalProperties":{"type":"number"}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/questions":{"get":{"operationId":"listSiteQuestions","summary":"List all questions in a site","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"name":"from","in":"query","description":"Filter stats to answers created at or after this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"to","in":"query","description":"Filter stats to answers created at or before this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"type","in":"query","description":"Filter questions by question type.","schema":{"$ref":"#/components/schemas/SiteQuestionType"}},{"name":"relevance","in":"query","description":"Filter questions by question relevance.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"}}},{"name":"answered","in":"query","description":"Filter questions by answer resolution.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"}}},{"name":"topic","in":"query","description":"Filter questions by associated site topic IDs.","schema":{"type":"array","items":{"type":"string"}}},{"$ref":"#/components/parameters/listOrder"},{"name":"sort","in":"query","description":"Sort questions by latest ask activity, answered rate, or positive feedback rate. If omitted, ordering stays on canonical question creation date to preserve current behavior.","schema":{"type":"string","enum":["askedAt","stats.answered","stats.feedback","stats.answers"]}},{"$ref":"#/components/parameters/listPage"},{"$ref":"#/components/parameters/listLimit"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestion"}}}}]}}}}}}}}}
```

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

> Get a site question by ID

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteQuestionId":{"name":"siteQuestionId","in":"path","required":true,"description":"The unique id of the site question","schema":{"type":"string"}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"Timestamp":{"type":"string","format":"date-time"},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"SiteQuestion":{"type":"object","properties":{"object":{"type":"string","enum":["site-question"]},"id":{"type":"string","description":"The ID of the site question."},"question":{"type":"string","description":"Canonical text for the unique site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"askedAt":{"$ref":"#/components/schemas/Timestamp"},"stats":{"$ref":"#/components/schemas/SiteQuestionStats"},"urls":{"type":"object","description":"URLs associated with the site question.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question in the API."}},"required":["location"]}},"required":["object","id","question","type","createdAt","askedAt","stats","urls"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteQuestionStats":{"type":"object","description":"Aggregated stats for questions and linked answers.","properties":{"total":{"type":"number","description":"Total count of questions included in the aggregation."},"answers":{"type":"number","description":"Total count of answers linked to the questions."},"feedback":{"$ref":"#/components/schemas/SiteQuestionStatsFeedback"},"answered":{"$ref":"#/components/schemas/SiteQuestionStatsAnswered"},"relevance":{"$ref":"#/components/schemas/SiteQuestionStatsRelevance"},"types":{"$ref":"#/components/schemas/SiteQuestionStatsTypes"},"channelTypes":{"$ref":"#/components/schemas/SiteQuestionStatsChannelTypes"},"channels":{"$ref":"#/components/schemas/SiteQuestionStatsChannels"},"weeklyPulse":{"type":"array","minItems":13,"maxItems":13,"description":"Weekly count of related question answers for the past 3 months.","items":{"type":"number"}}},"required":["total","answers","feedback","answered","relevance","types","channelTypes","channels","weeklyPulse"]},"SiteQuestionStatsFeedback":{"type":"object","description":"Aggregated feedback for answers linked to a site question.","properties":{"positive":{"type":"number","description":"Count of answers with positive feedback."},"negative":{"type":"number","description":"Count of answers with negative feedback."},"unrated":{"type":"number","description":"Count of answers without feedback."}},"required":["positive","negative","unrated"]},"SiteQuestionStatsAnswered":{"type":"object","description":"Aggregated answered assessment for answers linked to a site question.","properties":{"yes":{"type":"number","description":"Count of answers assessed as fully answered."},"partially":{"type":"number","description":"Count of answers assessed as partially answered."},"no":{"type":"number","description":"Count of answers assessed as not answered."}},"required":["yes","partially","no"]},"SiteQuestionStatsRelevance":{"type":"object","properties":{"relevant":{"type":"number"},"spam":{"type":"number"},"off-topic":{"type":"number"},"unclear":{"type":"number"}},"required":["relevant","spam","off-topic","unclear"]},"SiteQuestionStatsTypes":{"type":"object","properties":{"exploring":{"type":"number"},"how-to":{"type":"number"},"troubleshooting":{"type":"number"},"reference":{"type":"number"},"unknown":{"type":"number"}},"required":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteQuestionStatsChannelTypes":{"type":"object","description":"Count of answers by site channel type, including core channels.","additionalProperties":{"type":"number"}},"SiteQuestionStatsChannels":{"type":"object","description":"Count of answers by site channel ID.","additionalProperties":{"type":"number"}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId}":{"get":{"operationId":"getSiteQuestionById","summary":"Get a site question by ID","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteQuestionId"},{"name":"from","in":"query","description":"Filter stats to answers created at or after this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"to","in":"query","description":"Filter stats to answers created at or before this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"relevance","in":"query","description":"Filter stats by question relevance.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"}}},{"name":"answered","in":"query","description":"Filter stats by answer resolution.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteQuestion"}}}}}}}}}
```

## GET /orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId}/sources

> List sources for a question

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteQuestionId":{"name":"siteQuestionId","in":"path","required":true,"description":"The unique id of the site question","schema":{"type":"string"}},"listPage":{"name":"page","in":"query","description":"Identifier of the page results to fetch.","schema":{"type":"string"}},"listLimit":{"name":"limit","in":"query","description":"The number of results per page","schema":{"type":"number","minimum":0,"maximum":1000}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"Timestamp":{"type":"string","format":"date-time"},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"SiteQuestionAnswerSource":{"oneOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourcePage"},{"$ref":"#/components/schemas/SiteQuestionAnswerSourceRecord"}],"discriminator":{"propertyName":"type"}},"SiteQuestionAnswerSourcePage":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourceBase"},{"type":"object","title":"Page source","description":"Source data pointing to a page used for a site question answer.","properties":{"type":{"type":"string","enum":["page"]},"space":{"type":"string","description":"The space ID of the source page."},"revision":{"type":"string","description":"The revision ID used for this source page."},"page":{"type":"string","description":"The page ID of the source page."}},"required":["type","space","revision","page"]}]},"SiteQuestionAnswerSourceBase":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer-source"]},"id":{"type":"string","description":"The ID of the source."},"weight":{"type":"number","description":"Relative weight of this source in the generated answer."},"title":{"type":"string","description":"The title of the source."},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","title","weight","urls"]},"SiteQuestionAnswerSourceRecord":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourceBase"},{"type":"object","properties":{"type":{"type":"string","enum":["record"]},"record":{"type":"string","description":"The site context record ID."},"connector":{"$ref":"#/components/schemas/ContextConnector"}},"required":["type","record"]}]},"ContextConnector":{"oneOf":[{"type":"string","description":"Integration source","pattern":"^integration:[^:]+$"},{"type":"string","description":"Builtin sources","enum":["builtin:email","builtin:api","builtin:website","builtin:youtube","builtin:github-discussions","builtin:github-issues","builtin:intercom"]}]}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/questions/{siteQuestionId}/sources":{"get":{"operationId":"listSiteQuestionSources","summary":"List sources for a question","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteQuestionId"},{"$ref":"#/components/parameters/listPage"},{"$ref":"#/components/parameters/listLimit"},{"name":"from","in":"query","description":"Filter sources to answers created at or after this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"to","in":"query","description":"Filter sources to answers created at or before this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"relevance","in":"query","description":"Filter answer sources by question relevance.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"}}},{"name":"answered","in":"query","description":"Filter answer sources by answer resolution.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerSource"}}}}]}}}}}}}}}
```

## GET /orgs/{organizationId}/sites/{siteId}/question-stats

> Get question stats for a site

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"Timestamp":{"type":"string","format":"date-time"},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"SiteQuestionStats":{"type":"object","description":"Aggregated stats for questions and linked answers.","properties":{"total":{"type":"number","description":"Total count of questions included in the aggregation."},"answers":{"type":"number","description":"Total count of answers linked to the questions."},"feedback":{"$ref":"#/components/schemas/SiteQuestionStatsFeedback"},"answered":{"$ref":"#/components/schemas/SiteQuestionStatsAnswered"},"relevance":{"$ref":"#/components/schemas/SiteQuestionStatsRelevance"},"types":{"$ref":"#/components/schemas/SiteQuestionStatsTypes"},"channelTypes":{"$ref":"#/components/schemas/SiteQuestionStatsChannelTypes"},"channels":{"$ref":"#/components/schemas/SiteQuestionStatsChannels"},"weeklyPulse":{"type":"array","minItems":13,"maxItems":13,"description":"Weekly count of related question answers for the past 3 months.","items":{"type":"number"}}},"required":["total","answers","feedback","answered","relevance","types","channelTypes","channels","weeklyPulse"]},"SiteQuestionStatsFeedback":{"type":"object","description":"Aggregated feedback for answers linked to a site question.","properties":{"positive":{"type":"number","description":"Count of answers with positive feedback."},"negative":{"type":"number","description":"Count of answers with negative feedback."},"unrated":{"type":"number","description":"Count of answers without feedback."}},"required":["positive","negative","unrated"]},"SiteQuestionStatsAnswered":{"type":"object","description":"Aggregated answered assessment for answers linked to a site question.","properties":{"yes":{"type":"number","description":"Count of answers assessed as fully answered."},"partially":{"type":"number","description":"Count of answers assessed as partially answered."},"no":{"type":"number","description":"Count of answers assessed as not answered."}},"required":["yes","partially","no"]},"SiteQuestionStatsRelevance":{"type":"object","properties":{"relevant":{"type":"number"},"spam":{"type":"number"},"off-topic":{"type":"number"},"unclear":{"type":"number"}},"required":["relevant","spam","off-topic","unclear"]},"SiteQuestionStatsTypes":{"type":"object","properties":{"exploring":{"type":"number"},"how-to":{"type":"number"},"troubleshooting":{"type":"number"},"reference":{"type":"number"},"unknown":{"type":"number"}},"required":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteQuestionStatsChannelTypes":{"type":"object","description":"Count of answers by site channel type, including core channels.","additionalProperties":{"type":"number"}},"SiteQuestionStatsChannels":{"type":"object","description":"Count of answers by site channel ID.","additionalProperties":{"type":"number"}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/question-stats":{"get":{"operationId":"getSiteQuestionStats","summary":"Get question stats for a site","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"name":"from","in":"query","description":"Filter stats to answers created at or after this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"to","in":"query","description":"Filter stats to answers created at or before this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"topic","in":"query","description":"Filter stats by associated site topic IDs.","schema":{"type":"array","items":{"type":"string"}}},{"name":"relevance","in":"query","description":"Filter stats by question relevance.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"}}},{"name":"answered","in":"query","description":"Filter stats by answer resolution.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"}}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteQuestionStats"}}}}}}}}}
```

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

> List all answers for a site

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"listPage":{"name":"page","in":"query","description":"Identifier of the page results to fetch.","schema":{"type":"string"}},"listLimit":{"name":"limit","in":"query","description":"The number of results per page","schema":{"type":"number","minimum":0,"maximum":1000}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"Timestamp":{"type":"string","format":"date-time"},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"SiteQuestionAnswerHelpfulness":{"type":"string","description":"Helpfulness of the response for the end user need.","enum":["low","medium","high"]},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"SiteQuestionAnswer":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer"]},"id":{"type":"string","description":"The ID of the site question answer."},"question":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parent site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"}},"required":["id","type"]},"topics":{"type":"array","description":"The IDs of the associated site topics.","items":{"type":"string"}},"input":{"type":"object","required":["text","raw"],"properties":{"text":{"type":"string","description":"Normalized question text for this answer."},"raw":{"type":"string","description":"Raw question text as asked by the user."}}},"thread":{"type":"object","required":["id","previous"],"properties":{"id":{"type":"string","description":"The ID of the thread this answer belongs to."},"previous":{"type":"string","description":"ID of the previous answer in the same thread."}}},"session":{"$ref":"#/components/schemas/SiteInsightsSession"},"feedback":{"type":"object","required":["rating"],"properties":{"rating":{"type":"integer","enum":[-1,1],"description":"Feedback rating provided by the user."}}},"responseId":{"type":"string","description":"The response identifier for this answer."},"language":{"type":"string","description":"ISO language code of the question."},"answered":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"},"helpfulness":{"$ref":"#/components/schemas/SiteQuestionAnswerHelpfulness"},"relevance":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"},"channel":{"oneOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteCoreChannelType"}},"required":["type"]},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteConfigurableChannelType"},"id":{"type":["string","null"],"description":"ID of the associated site channel when the answer originates from a configurable channel. Null if the channel has been deleted."}},"required":["type","id"]}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","question","topics","input","responseId","language","answered","helpfulness","relevance","channel","createdAt","urls"]},"SiteInsightsSession":{"type":"object","description":"Identifiers for a GitBook site session, used for analytics and adaptive content.","properties":{"visitorId":{"type":"string","description":"GitBook's unique identifier of the visitor."},"sessionId":{"type":"string","description":"GitBook's unique identifier of the visitor's session."}},"required":["visitorId","sessionId"]},"SiteCoreChannelType":{"type":"string","enum":["site","embed","api"]},"SiteConfigurableChannelType":{"type":"string","enum":["builtin:slack","builtin:discord","builtin:github"]}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/answers":{"get":{"operationId":"listSiteQuestionAnswers","summary":"List all answers for a site","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"name":"question","in":"query","description":"Filter answers to a specific site question ID.","schema":{"type":"string"}},{"name":"from","in":"query","description":"Filter answers created at or after this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"to","in":"query","description":"Filter answers created at or before this timestamp.","schema":{"$ref":"#/components/schemas/Timestamp"}},{"name":"language","in":"query","description":"Filter answers by ISO language code.","schema":{"type":"string"}},{"name":"answered","in":"query","description":"Filter answers by answered resolution.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"}}},{"name":"helpfulness","in":"query","description":"Filter answers by answered helpfulness.","schema":{"$ref":"#/components/schemas/SiteQuestionAnswerHelpfulness"}},{"name":"relevance","in":"query","description":"Filter answers by question relevance.","schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"}}},{"name":"question.type","in":"query","description":"Filter answers by question type.","schema":{"$ref":"#/components/schemas/SiteQuestionType"}},{"name":"topic","in":"query","description":"Filter answers by associated site topic ID.","schema":{"type":"string"}},{"name":"thread","in":"query","description":"Filter answers by thread root answer ID. Includes the root answer itself.","schema":{"type":"string"}},{"$ref":"#/components/parameters/listPage"},{"$ref":"#/components/parameters/listLimit"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswer"}}}}]}}}}}}}}}
```

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

> Get a site answer by ID

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteQuestionAnswerId":{"name":"siteQuestionAnswerId","in":"path","required":true,"description":"The unique id of the site question answer","schema":{"type":"string"}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"SiteQuestionAnswerWithResponse":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswer"},{"type":"object","properties":{"response":{"$ref":"#/components/schemas/AIMessage"}},"required":["response"]}]},"SiteQuestionAnswer":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer"]},"id":{"type":"string","description":"The ID of the site question answer."},"question":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parent site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"}},"required":["id","type"]},"topics":{"type":"array","description":"The IDs of the associated site topics.","items":{"type":"string"}},"input":{"type":"object","required":["text","raw"],"properties":{"text":{"type":"string","description":"Normalized question text for this answer."},"raw":{"type":"string","description":"Raw question text as asked by the user."}}},"thread":{"type":"object","required":["id","previous"],"properties":{"id":{"type":"string","description":"The ID of the thread this answer belongs to."},"previous":{"type":"string","description":"ID of the previous answer in the same thread."}}},"session":{"$ref":"#/components/schemas/SiteInsightsSession"},"feedback":{"type":"object","required":["rating"],"properties":{"rating":{"type":"integer","enum":[-1,1],"description":"Feedback rating provided by the user."}}},"responseId":{"type":"string","description":"The response identifier for this answer."},"language":{"type":"string","description":"ISO language code of the question."},"answered":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"},"helpfulness":{"$ref":"#/components/schemas/SiteQuestionAnswerHelpfulness"},"relevance":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"},"channel":{"oneOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteCoreChannelType"}},"required":["type"]},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteConfigurableChannelType"},"id":{"type":["string","null"],"description":"ID of the associated site channel when the answer originates from a configurable channel. Null if the channel has been deleted."}},"required":["type","id"]}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","question","topics","input","responseId","language","answered","helpfulness","relevance","channel","createdAt","urls"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteInsightsSession":{"type":"object","description":"Identifiers for a GitBook site session, used for analytics and adaptive content.","properties":{"visitorId":{"type":"string","description":"GitBook's unique identifier of the visitor."},"sessionId":{"type":"string","description":"GitBook's unique identifier of the visitor's session."}},"required":["visitorId","sessionId"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"SiteQuestionAnswerHelpfulness":{"type":"string","description":"Helpfulness of the response for the end user need.","enum":["low","medium","high"]},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteCoreChannelType":{"type":"string","enum":["site","embed","api"]},"SiteConfigurableChannelType":{"type":"string","enum":["builtin:slack","builtin:discord","builtin:github"]},"Timestamp":{"type":"string","format":"date-time"},"AIMessage":{"type":"object","properties":{"id":{"type":"string"},"role":{"$ref":"#/components/schemas/AIMessageRole"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AIMessageStep"}},"task":{"$ref":"#/components/schemas/AIMessageTask"},"response":{"$ref":"#/components/schemas/AIMessageResponseMetadata"}},"required":["id","role","steps"]},"AIMessageRole":{"type":"string","enum":["user","assistant"]},"AIMessageStep":{"type":"object","description":"A step in a message from the AI agent.","properties":{"content":{"$ref":"#/components/schemas/JSONDocument"},"reasoning":{"$ref":"#/components/schemas/JSONDocument"},"toolCalls":{"type":"array","items":{"$ref":"#/components/schemas/AIToolCall"}},"timing":{"type":"object","description":"The timing of the step.","properties":{"reasoning":{"$ref":"#/components/schemas/Timerange"}}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AIAttachment"}}},"required":["content"]},"JSONDocument":{"type":"object","properties":{"object":{"type":"string","enum":["document"]},"data":{"type":"object","properties":{"schemaVersion":{"description":"The schema version of the document. If undefined, the document is considered to be of the latest schema version.","type":"integer"}},"additionalProperties":true},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksTopLevels"}},"meta":{"type":"object","properties":{"token":{"description":"A content token that can be used to fetch the content referenced in this document from the API.","type":"string"}}}},"required":["object","data","nodes"]},"DocumentBlocksTopLevels":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockOpenAPI"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIOperation"},{"$ref":"#/components/schemas/DocumentBlockOpenAPISchemas"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIWebhook"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockStepper"},{"$ref":"#/components/schemas/DocumentBlockIf"},{"$ref":"#/components/schemas/DocumentBlockColumns"}]},"DocumentBlocksEssentials":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockParagraph"},{"$ref":"#/components/schemas/DocumentBlockHeading"},{"$ref":"#/components/schemas/DocumentBlockListOrdered"},{"$ref":"#/components/schemas/DocumentBlockListUnordered"},{"$ref":"#/components/schemas/DocumentBlockListTasks"},{"$ref":"#/components/schemas/DocumentBlockDivider"}]},"DocumentBlockParagraph":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["paragraph"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentInline"},{"$ref":"#/components/schemas/DocumentText"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"align":{"$ref":"#/components/schemas/TextAlignment"}},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentInline":{"oneOf":[{"$ref":"#/components/schemas/DocumentInlineLink"},{"$ref":"#/components/schemas/DocumentInlineEmoji"},{"$ref":"#/components/schemas/DocumentInlineIcon"},{"$ref":"#/components/schemas/DocumentInlineExpression"},{"$ref":"#/components/schemas/DocumentInlineMath"},{"$ref":"#/components/schemas/DocumentInlineImage"},{"$ref":"#/components/schemas/DocumentInlineAnnotation"},{"$ref":"#/components/schemas/DocumentInlineMention"},{"$ref":"#/components/schemas/DocumentInlineButton"}]},"DocumentInlineLink":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["link"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentText"},{"$ref":"#/components/schemas/DocumentInlineImage"}]}},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentText":{"type":"object","properties":{"object":{"type":"string","enum":["text"]},"key":{"type":"string"},"leaves":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTextLeaf"}}},"required":["object","leaves"]},"DocumentTextLeaf":{"type":"object","properties":{"object":{"type":"string","enum":["leaf"]},"text":{"type":"string"},"marks":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTextMark"}}},"required":["object","text","marks"]},"DocumentTextMark":{"oneOf":[{"$ref":"#/components/schemas/DocumentMarkBold"},{"$ref":"#/components/schemas/DocumentMarkItalic"},{"$ref":"#/components/schemas/DocumentMarkCode"},{"$ref":"#/components/schemas/DocumentMarkKeyboard"},{"$ref":"#/components/schemas/DocumentMarkStrikethrough"},{"$ref":"#/components/schemas/DocumentMarkColor"},{"$ref":"#/components/schemas/DocumentMarkSuperscript"},{"$ref":"#/components/schemas/DocumentMarkSubscript"}]},"DocumentMarkBold":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["bold"]}},"required":["object","type"]},"DocumentMarkItalic":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["italic"]}},"required":["object","type"]},"DocumentMarkCode":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["code"]}},"required":["object","type"]},"DocumentMarkKeyboard":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["keyboard"]}},"required":["object","type"]},"DocumentMarkStrikethrough":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["strikethrough"]}},"required":["object","type"]},"DocumentMarkColor":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["color"]},"data":{"type":"object","properties":{"text":{"$ref":"#/components/schemas/DocumentTextColor"},"background":{"$ref":"#/components/schemas/DocumentTextColor"}},"required":["text","background"]}},"required":["object","type","data"]},"DocumentTextColor":{"type":"string","enum":["default","green","blue","red","orange","yellow","purple","$primary","$info","$success","$warning","$danger"]},"DocumentMarkSuperscript":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["superscript"]}},"required":["object","type"]},"DocumentMarkSubscript":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["subscript"]}},"required":["object","type"]},"DocumentInlineImage":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["inline-image"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"refDark":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"caption":{"type":"string"},"alt":{"type":"string"},"size":{"type":"string","enum":["original","line"]}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefTag"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefTag":{"type":"object","properties":{"kind":{"type":"string","enum":["tag"]},"tag":{"type":"string","description":"The slug of the tag, also used as the ID, and references the tags defined on a revision."},"space":{"type":"string","description":"The space in which the tag is defined. If undefined, the tag is assumed to be in the same space as the content reference."}},"required":["kind","tag"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"DocumentInlineEmoji":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["emoji"]},"key":{"type":"string"},"data":{"type":"object","properties":{"code":{"type":"string"}},"required":["code"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineIcon":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["icon"]},"key":{"type":"string"},"data":{"type":"object","properties":{"icon":{"type":"string"},"color":{"$ref":"#/components/schemas/DocumentTextColor"}},"required":["icon"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineExpression":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["expression"]},"key":{"type":"string"},"data":{"type":"object","properties":{"expression":{"type":"string"}},"required":["expression"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineMath":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["inline-math"]},"key":{"type":"string"},"data":{"type":"object","properties":{"formula":{"type":"string"}},"required":["formula"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineAnnotation":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["annotation"]},"key":{"type":"string"},"fragments":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"type":{"type":"string","enum":["annotation-body"]},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockCode"}]},"minItems":1}},"required":["nodes","type"]}]}},"isVoid":{"type":"boolean","enum":[false]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentText"}},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","fragments","isVoid","nodes"]},"DocumentFragment":{"type":"object","properties":{"object":{"type":"string","enum":["fragment"]},"key":{"type":"string"},"fragment":{"type":"string"},"type":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlock"}}},"required":["object","nodes"]},"DocumentBlock":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockParagraph"},{"$ref":"#/components/schemas/DocumentBlockHeading"},{"$ref":"#/components/schemas/DocumentBlockListOrdered"},{"$ref":"#/components/schemas/DocumentBlockListUnordered"},{"$ref":"#/components/schemas/DocumentBlockListTasks"},{"$ref":"#/components/schemas/DocumentBlockListItem"},{"$ref":"#/components/schemas/DocumentBlockDivider"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockIf"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockImage"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockCodeLine"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockTabsItem"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockOpenAPI"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIOperation"},{"$ref":"#/components/schemas/DocumentBlockOpenAPISchemas"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIWebhook"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockStepper"},{"$ref":"#/components/schemas/DocumentBlockStepperStep"},{"$ref":"#/components/schemas/DocumentBlockColumns"},{"$ref":"#/components/schemas/DocumentBlockColumn"},{"$ref":"#/components/schemas/DocumentBlockUpdates"},{"$ref":"#/components/schemas/DocumentBlockUpdate"}]},"DocumentBlockHeading":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["heading-1","heading-2","heading-3"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentInline"},{"$ref":"#/components/schemas/DocumentText"}]}},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^[-a-z0-9.+_]+$"},"align":{"$ref":"#/components/schemas/TextAlignment"}}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"TextAlignment":{"type":"string","enum":["start","center","end"]},"DocumentBlockListOrdered":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-ordered"]},"key":{"type":"string"},"data":{"type":"object","properties":{"start":{"type":"number","description":"An integer to start counting from for the list items."}}},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"DocumentBlockListItem":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-item"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockTable"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"checked":{"type":"boolean"}}}},"required":["object","type","nodes"]},"DocumentBlockCode":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["code"]},"key":{"type":"string"},"data":{"type":"object","properties":{"syntax":{"type":"string"},"title":{"type":"string"},"overflow":{"type":"string","default":"scroll","enum":["scroll","wrap"]},"lineNumbers":{"type":"boolean"},"fullWidth":{"type":"boolean"},"expandable":{"type":"boolean"},"collapsedLineCount":{"type":"integer","description":"Number of lines rendered in a code block when it is collapsed","minimum":1,"default":10}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockCodeLine"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"DocumentBlockCodeLine":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["code-line"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentText"},{"$ref":"#/components/schemas/DocumentInlineAnnotation"},{"$ref":"#/components/schemas/DocumentInlineExpression"}]}},"data":{"type":"object","properties":{"highlighted":{"type":"boolean"}}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockHint":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["hint"]},"key":{"type":"string"},"data":{"type":"object","properties":{"style":{"type":"string","enum":["info","warning","danger","success"]},"icon":{"$ref":"#/components/schemas/Icon"}},"required":["style"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksEssentials"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"Icon":{"type":"string","maxLength":50,"format":"icon","description":"Name of the icon"},"DocumentBlockQuote":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["blockquote"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockQuote"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockMath":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["math"]},"key":{"type":"string"},"data":{"type":"object","properties":{"formula":{"type":"string"}},"required":["formula"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockTable":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["table"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"view":{"oneOf":[{"$ref":"#/components/schemas/DocumentTableViewGrid"},{"$ref":"#/components/schemas/DocumentTableViewCards"}]},"records":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentTableRecord"}},"definition":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentTableDefinition"}},"fullWidth":{"type":"boolean","description":"Whether to render the block as a full width one"}},"required":["view","records","definition"]},"fragments":{"type":"array","items":{"$ref":"#/components/schemas/DocumentFragment"}}},"required":["object","type","data","isVoid","fragments"]},"DocumentTableViewGrid":{"type":"object","properties":{"type":{"type":"string","enum":["grid"]},"columns":{"type":"array","description":"Ordered list of the definition IDs to display","items":{"type":"string"}},"columnWidths":{"type":"object","description":"Percent width of each column","additionalProperties":{"type":"number"}},"hideHeader":{"type":"boolean","description":"Should we display the header with column titles"},"stickyHeader":{"type":"boolean","description":"Should we keep the table header sticky while the page scrolls"},"useNewSizing":{"type":"boolean","description":"Tables in GitBook originally used a scaled width approach i.e. the width defined\nin columnWidths would be scaled to ensure a 100% width table.\n\nWe later changed this to treat the widths in columnWidths as exact values - they are\nnever scaled. A columnWidth of 50 is rendered as 50px.\n\nIn order to maintain backwards compatibility, we track whether or not we\nuse the new system here.\n\nAll new tables should have this value set to true, older tables will have it set\nto undefined.\n"}},"required":["type","columns","hideHeader"]},"DocumentTableViewCards":{"type":"object","properties":{"type":{"type":"string","enum":["cards"]},"cardSize":{"type":"string","description":"Size of the cards. It indicates how many columns will be used","enum":["medium","large"]},"columns":{"type":"array","description":"Ordered list of the definition IDs to display","items":{"type":"string"}},"targetDefinition":{"type":"string","description":"Definition ID to use as a target link for the card"},"coverDefinition":{"type":"string","description":"Definition ID to use as a cover image"},"coverDefinitionDark":{"type":"string","description":"Definition ID to use as a dark mode cover image"},"hideColumnTitle":{"type":"boolean","description":"Should we display the column title or not"}},"required":["type","columns","cardSize"]},"DocumentTableRecord":{"type":"object","properties":{"orderIndex":{"type":"string"},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"number"},{"type":["string","null"]},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/ContentRef"},{"$ref":"#/components/schemas/DocumentTableImageRecord"}]}}},"required":["orderIndex","values"]},"DocumentTableImageRecord":{"description":"A table record value for image columns, supporting both direct ContentRefs and the additional format with record-level settings.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"}]},"objectFit":{"$ref":"#/components/schemas/CardsImageObjectFit"},"alt":{"type":"string","description":"Alternative text for the cover image"}},"required":["ref"]}]},"CardsImageObjectFit":{"type":"string","description":"Object fit for image display in card views","enum":["contain","fill","cover"]},"DocumentTableDefinition":{"oneOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionText"},{"$ref":"#/components/schemas/DocumentTableDefinitionNumber"},{"$ref":"#/components/schemas/DocumentTableDefinitionCheckbox"},{"$ref":"#/components/schemas/DocumentTableDefinitionFiles"},{"$ref":"#/components/schemas/DocumentTableDefinitionUsers"},{"$ref":"#/components/schemas/DocumentTableDefinitionRating"},{"$ref":"#/components/schemas/DocumentTableDefinitionSelect"},{"$ref":"#/components/schemas/DocumentTableDefinitionContentRef"},{"$ref":"#/components/schemas/DocumentTableDefinitionImage"}]},"DocumentTableDefinitionText":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"textAlignment":{"type":"string","enum":["center","right","left"]},"verticalAlignment":{"$ref":"#/components/schemas/VerticalAlignment"}},"required":["type","textAlignment"]}]},"DocumentTableDefinitionBase":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","description":"Title for the column"}},"required":["id","title"]},"VerticalAlignment":{"type":"string","enum":["top","middle","bottom"]},"DocumentTableDefinitionNumber":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["number"]}},"required":["type"]}]},"DocumentTableDefinitionCheckbox":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["checkbox"]}},"required":["type"]}]},"DocumentTableDefinitionFiles":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["files"]}},"required":["type"]}]},"DocumentTableDefinitionUsers":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"multiple":{"type":"boolean"}},"required":["type","multiple"]}]},"DocumentTableDefinitionRating":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["rating"]},"max":{"type":"number"}},"required":["type","max"]}]},"DocumentTableDefinitionSelect":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["select"]},"multiple":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTableSelectOption"}}},"required":["type","multiple","options"]}]},"DocumentTableSelectOption":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"color":{"type":"string"}},"required":["value","label","color"]},"DocumentTableDefinitionContentRef":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["content-ref"]}},"required":["type"]}]},"DocumentTableDefinitionImage":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["image"]}},"required":["type"]}]},"DocumentBlockListUnordered":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-unordered"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"data":{"type":"object","additionalProperties":false},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes"]},"DocumentBlockListTasks":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-tasks"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockDivider":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["divider"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","isVoid","data"]},"DocumentBlockIf":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["if"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksTopLevels"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"expression":{"type":"string"}},"required":["expression"]}},"required":["object","type","nodes","data"]},"DocumentBlockImages":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["images"]},"key":{"type":"string"},"data":{"type":"object","properties":{"align":{"type":"string","enum":["center","left","right"]},"fullWidth":{"type":"boolean"},"withFrame":{"type":"boolean"}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockImage"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes","isVoid"]},"DocumentBlockImage":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["image"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"refDark":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"width":{"$ref":"#/components/schemas/Length"},"height":{"$ref":"#/components/schemas/Length"},"alt":{"type":"string"}},"required":["ref"]},"fragments":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["caption"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockParagraph"}}},"required":["nodes","fragment"]}]}},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","fragments","isVoid"]},"Length":{"oneOf":[{"type":"number"},{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["unit","value"]}]},"DocumentBlockFile":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["file"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"}]}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockDrawing":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["drawing"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"}]}}},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockEmbed":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["embed"]},"key":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"fullWidth":{"type":"boolean"}},"required":["url"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockExpandable":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["expandable"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"defaultExpanded":{"type":"boolean"}},"additionalProperties":false},"fragments":{"type":"array","items":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["expandable-title"]},"type":{"type":"string","enum":["expandable-title"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockParagraph"},"minItems":1,"maxItems":1}},"required":["nodes","fragment","type"]}]},{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["expandable-body"]},"type":{"type":"string","enum":["expandable-body"]},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockIntegration"}]},"minItems":1}},"required":["nodes","fragment","type"]}]}]}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","isVoid","fragments","data"]},"DocumentBlockReusableContent":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["reusable-content"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefReusableContent"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"token":{"description":"A content token that can be used to fetch the reusable content from the API.","type":"string"}}}},"required":["object","type","data","isVoid"]},"DocumentBlockIntegration":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["integration"]},"key":{"type":"string"},"data":{"type":"object","properties":{"integration":{"type":"string","description":"Name of the integration"},"block":{"type":"string","description":"ID of the block in the integration"},"props":{"description":"Properties passed to the block during rendering","$ref":"#/components/schemas/PlainObject"},"action":{"$ref":"#/components/schemas/ContentKitAction"},"url":{"type":"string","description":"URL associated with the content represented by the block.\nThis property is set when creating a block from a URL (unfurl) to ensure\nwe can convert the block back to an embed.\n"},"fullWidth":{"type":"boolean"}},"required":["integration","block","props"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"PlainObject":{"properties":{},"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/PlainObject"},{"type":"string"},{"type":"boolean"},{"type":"number"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"},{"$ref":"#/components/schemas/PlainObject"}]}}]}},"ContentKitAction":{"anyOf":[{"type":"object","description":"Custom action to re-render the block.","properties":{"action":{"type":"string"}},"additionalProperties":true,"required":["action"]},{"$ref":"#/components/schemas/ContentKitDefaultAction"}]},"ContentKitDefaultAction":{"oneOf":[{"type":"object","description":"Action to open an overlay modal defined by \"componentId\".","properties":{"action":{"type":"string","enum":["@ui.modal.open"]},"componentId":{"type":"string"},"props":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","componentId","props"]},{"type":"object","description":"Action when a modal overlay is closed, with a return value to the higher level component in the stack. This action will be triggered on the parent component instance.","properties":{"action":{"type":"string","enum":["@ui.modal.close"]},"returnValue":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","returnValue"]},{"type":"object","description":"Action to open an url.","properties":{"action":{"type":"string","enum":["@ui.url.open"]},"url":{"type":"string"}},"required":["action","url"]},{"type":"object","description":"Action when a link is being unfurled into a block.","properties":{"action":{"type":"string","enum":["@link.unfurl"]},"url":{"type":"string"}},"required":["action","url"]},{"type":"object","description":"Action to update the properties stored in the related node.","properties":{"action":{"type":"string","enum":["@editor.node.updateProps"]},"props":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","props"]}]},"DocumentBlockTabs":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["tabs"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockTabsItem"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"fullWidth":{"type":"boolean"}},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockTabsItem":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["tabs-item"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"}]}},"data":{"type":"object","properties":{"title":{"type":"string"}}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockContentRef":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["content-ref"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockOpenAPI":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["swagger"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIOperationPointer"},{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"}]},"expanded":{"type":"boolean","description":"If true, the block is opened by default."},"fullWidth":{"type":"boolean"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPIOperationPointer":{"type":"object","description":"Pointer to an operation in the OpenAPI spec.","properties":{"path":{"type":"string","description":"Path of the operation in the OpenAPI spec."},"method":{"type":"string","description":"HTTP method of the operation in the OpenAPI spec."}},"required":["path","method"]},"DocumentBlockOpenAPIOperation":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-operation"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIOperationPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"DocumentBlockOpenAPISchemas":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-schemas"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPISchemasPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}],"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPISchemasPointer":{"type":"object","description":"Pointer to schemas in the OpenAPI spec.","properties":{"grouped":{"type":"boolean","description":"Whether the schemas are grouped or not.","default":true},"schemas":{"type":"array","description":"List of schemas name from the OpenAPI spec.","items":{"type":"string"}},"title":{"type":"string","description":"Custom title for the schemas block. When not provided, defaults to \"The <SchemaName> object\"."}},"required":["schemas"]},"DocumentBlockOpenAPIWebhook":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-webhook"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIWebhookPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPIWebhookPointer":{"type":"object","description":"Pointer to a webhook in the OpenAPI spec.","properties":{"name":{"type":"string","description":"Name of the webhook in the OpenAPI spec."},"method":{"type":"string","description":"HTTP method of the webhook in the OpenAPI spec."}},"required":["name","method"]},"DocumentBlockStepper":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["stepper"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockStepperStep"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockStepperStep":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["stepper-step"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockExpandable"}]}},"data":{"type":"object","properties":{"icon":{"type":"string"}}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockColumns":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["columns"]},"key":{"type":"string"},"data":{"type":"object","properties":{"fullWidth":{"type":"boolean"}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockColumn"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes","isVoid"]},"DocumentBlockColumn":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["column"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockStepper"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"width":{"$ref":"#/components/schemas/Length"},"verticalAlignment":{"$ref":"#/components/schemas/VerticalAlignment"}},"additionalProperties":false}},"required":["object","type","nodes","data"]},"DocumentBlockUpdates":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["updates"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockUpdate"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"format":{"type":"string","enum":["numeric","full","short"],"default":"full"}},"required":["format"],"additionalProperties":false}},"required":["object","type","nodes","data"]},"DocumentBlockUpdate":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["update"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockExpandable"}]}},"data":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/Timestamp"},"tags":{"type":"array","description":"Array of tags. Each tag is id'ed by its slug.","items":{"$ref":"#/components/schemas/ContentRefTag"}}},"required":["date"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentInlineMention":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["mention"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineButton":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["button"]},"key":{"type":"string"},"data":{"allOf":[{"type":"object","properties":{"label":{"type":"string"},"kind":{"type":"string","enum":["primary","secondary"]},"icon":{"$ref":"#/components/schemas/Icon"}},"required":["label","kind"]},{"oneOf":[{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"],"additionalProperties":false},{"type":"object","properties":{"action":{"$ref":"#/components/schemas/DocumentAction"}},"required":["action"],"additionalProperties":false}]}]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentAction":{"type":"object","oneOf":[{"type":"object","properties":{"action":{"type":"string","enum":["search"]},"query":{"type":"string"}},"required":["action"],"additionalProperties":false},{"type":"object","properties":{"action":{"type":"string","enum":["ask"]},"query":{"type":"string"}},"required":["action"],"additionalProperties":false}]},"AIToolCall":{"oneOf":[{"$ref":"#/components/schemas/AIToolCallGetPageContent"},{"$ref":"#/components/schemas/AIToolCallGetRecordContent"},{"$ref":"#/components/schemas/AIToolCallGetPages"},{"$ref":"#/components/schemas/AIToolCallGetReusableContents"},{"$ref":"#/components/schemas/AIToolCallSearch"},{"$ref":"#/components/schemas/AIToolCallEditPage"},{"$ref":"#/components/schemas/AIToolCallCreatePage"},{"$ref":"#/components/schemas/AIToolCallDeletePage"},{"$ref":"#/components/schemas/AIToolCallRenamePage"},{"$ref":"#/components/schemas/AIToolCallMovePage"},{"$ref":"#/components/schemas/AIToolCallListModifiedPages"},{"$ref":"#/components/schemas/AIToolCallGetPageDiff"},{"$ref":"#/components/schemas/AIToolCallCreateReusableContent"},{"$ref":"#/components/schemas/AIToolCallEditReusableContent"},{"$ref":"#/components/schemas/AIToolCallGetReusableContent"},{"$ref":"#/components/schemas/AIToolCallCreateChangeRequest"},{"$ref":"#/components/schemas/AIToolCallComment"},{"$ref":"#/components/schemas/AIToolCallReplyToComment"},{"$ref":"#/components/schemas/AIToolCallSubmitChangeRequestReview"},{"$ref":"#/components/schemas/AIToolCallMCP"},{"$ref":"#/components/schemas/AIToolCallOther"}]},"AIToolCallGetPageContent":{"type":"object","properties":{"tool":{"type":"string","enum":["getPageContent"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The ID of the revision within which the page content is being fetched."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page","revisionId"]},"ChangedRevisionPage":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/RevisionPageType"},"title":{"type":"string"},"path":{"type":"string"}},"required":["id","type","title"]},"RevisionPageType":{"type":"string","enum":["document","group","link","computed"]},"AIToolCallGetRecordContent":{"type":"object","description":"Tool to read the body of an external record.","properties":{"tool":{"type":"string","enum":["getRecordContent"]},"siteId":{"type":"string","description":"The ID of the site owning the context record."},"recordId":{"type":"string","description":"The ID of the context record."},"title":{"type":"string","description":"The title of the record."},"url":{"type":"string","format":"uri","description":"URL of the record in the source system."}},"required":["tool","siteId","recordId","title"]},"AIToolCallGetPages":{"type":"object","properties":{"tool":{"type":"string","enum":["getPages"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The revision ID of the space."}},"required":["tool","spaceId","revisionId"]},"AIToolCallGetReusableContents":{"type":"object","properties":{"tool":{"type":"string","enum":["getReusableContents"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The revision ID of the space."}},"required":["tool","spaceId","revisionId"]},"AIToolCallSearch":{"type":"object","description":"Tool to search for content","properties":{"tool":{"type":"string","enum":["search"]},"query":{"type":"string","description":"The query that has been searched for."},"results":{"type":"array","items":{"$ref":"#/components/schemas/AIToolCallSearchResult"}}},"required":["tool","query","results"]},"AIToolCallSearchResult":{"description":"Result of a search","oneOf":[{"$ref":"#/components/schemas/AIToolCallSearchResultPage"},{"$ref":"#/components/schemas/AIToolCallSearchResultRecord"}],"discriminator":{"propertyName":"type"}},"AIToolCallSearchResultPage":{"type":"object","title":"Page result","description":"Result of a search matching a page.","properties":{"type":{"type":"string","enum":["page"]},"spaceId":{"type":"string","description":"The ID of the space"},"pageId":{"type":"string","description":"The ID of the page"},"revisionId":{"type":"string","description":"The revision ID of the result"},"anchor":{"type":"string","description":"The anchor of the result"},"title":{"type":"string","description":"The title of the result"},"description":{"type":"string","description":"The description of the result"}},"required":["type","spaceId","pageId","revisionId","title"]},"AIToolCallSearchResultRecord":{"type":"object","title":"Site context record result","description":"Result of a search matching a site context record.","properties":{"type":{"type":"string","enum":["record"]},"siteId":{"type":"string","description":"The ID of the site owning the context record"},"recordId":{"type":"string","description":"The ID of the context record"},"title":{"type":"string","description":"The title of the record"},"description":{"type":"string","description":"The description of the record"},"url":{"type":"string","format":"uri","description":"URL of the record in its original source"}},"required":["type","siteId","recordId","title"]},"AIToolCallEditPage":{"type":"object","properties":{"tool":{"type":"string","enum":["editPage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallCreatePage":{"type":"object","properties":{"tool":{"type":"string","enum":["createPage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallDeletePage":{"type":"object","properties":{"tool":{"type":"string","enum":["deletePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallRenamePage":{"type":"object","properties":{"tool":{"type":"string","enum":["renamePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"},"title":{"type":"string","description":"The new title of the page."}},"required":["tool","spaceId","page","title"]},"AIToolCallMovePage":{"type":"object","properties":{"tool":{"type":"string","enum":["movePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"},"to":{"$ref":"#/components/schemas/ChangedRevisionPage"},"moveType":{"type":"string","description":"Indicates how the page was moved relative to the \"to\" page.\n- `within`: moved as the last child of the target page (or to the root when `to` is omitted)\n- `before`: moved directly before the target page\n- `after`: moved directly after the target page\n","enum":["within","before","after"]}},"required":["tool","spaceId","page","moveType"]},"AIToolCallListModifiedPages":{"type":"object","properties":{"tool":{"type":"string","enum":["listModifiedPages"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."}},"required":["tool","spaceId"]},"AIToolCallGetPageDiff":{"type":"object","properties":{"tool":{"type":"string","enum":["getPageDiff"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallCreateReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["createReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent"]},"ChangedRevisionReusableContent":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"document":{"type":"string"}},"required":["id","title"]},"AIToolCallEditReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["editReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent"]},"AIToolCallGetReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["getReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The ID of the revision within which the reusable content is being fetched."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent","revisionId"]},"AIToolCallCreateChangeRequest":{"type":"object","properties":{"tool":{"type":"string","enum":["createChangeRequest"]},"spaceId":{"type":"string","description":"The ID of the space the change request belongs to."},"action":{"type":"string","enum":["create","update"]},"changeRequest":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the change request."},"number":{"type":"number","description":"Incremental identifier of the change request."},"subject":{"type":"string","description":"A brief summary of the change request."}},"required":["id","number","subject"]}},"required":["tool","spaceId","action","changeRequest"]},"AIToolCallComment":{"type":"object","properties":{"tool":{"type":"string","enum":["comment"]},"spaceId":{"type":"string","description":"The ID of the space being commented."},"page":{"description":"The page being commented.","$ref":"#/components/schemas/ChangedRevisionPage"},"commentId":{"type":"string","description":"The ID of the comment being posted."}},"required":["tool","spaceId","commentId"]},"AIToolCallReplyToComment":{"type":"object","properties":{"tool":{"type":"string","enum":["replyToComment"]},"spaceId":{"type":"string","description":"The ID of the space being commented."},"page":{"description":"The page being commented.","$ref":"#/components/schemas/ChangedRevisionPage"},"commentId":{"type":"string","description":"The ID of the comment being replied to."},"replyId":{"type":"string","description":"The ID of the reply being posted."}},"required":["tool","spaceId","commentId","replyId"]},"AIToolCallSubmitChangeRequestReview":{"type":"object","properties":{"tool":{"type":"string","enum":["submitChangeRequestReview"]},"spaceId":{"type":"string","description":"The ID of the space where the review was submitted."},"changeRequestId":{"type":"string","description":"The ID of the change request being reviewed."},"status":{"$ref":"#/components/schemas/ChangeRequestReviewStatus","description":"Result of the review."},"reviewId":{"type":"string","description":"Identifier of the review that was created."},"commentId":{"type":"string","description":"Identifier of the comment that was created as part of the review."}},"required":["tool","spaceId","changeRequestId","status","reviewId","commentId"]},"ChangeRequestReviewStatus":{"type":"string","description":"Status of a change request review.","enum":["changes-requested","approved"]},"AIToolCallMCP":{"type":"object","description":"Tool called from an MCP server","properties":{"tool":{"type":"string","enum":["mcp"]},"mcpServerId":{"type":"string","description":"The ID of the MCP server that has been called."},"mcpToolName":{"type":"string","description":"The name of the tool that has been called."},"mcpToolTitle":{"type":"string","description":"The title of the tool that has been called."}},"required":["tool","mcpServerId","mcpToolName"]},"AIToolCallOther":{"type":"object","description":"Any tool call that is unknown by GitBook","properties":{"tool":{"type":"string","enum":["other"]},"summary":{"$ref":"#/components/schemas/AIToolCallOtherSummary"}},"required":["tool","summary"]},"AIToolCallOtherSummary":{"type":"object","description":"Summary of a generic tool call.","properties":{"icon":{"$ref":"#/components/schemas/Icon"},"text":{"type":"string","description":"Text to display to the user to describe the tool call."}},"required":["icon","text"]},"Timerange":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"end":{"$ref":"#/components/schemas/Timestamp"}},"required":["start","end"]},"AIAttachment":{"oneOf":[{"$ref":"#/components/schemas/AIAttachmentImage"},{"$ref":"#/components/schemas/AIAttachmentFile"}]},"AIAttachmentImage":{"type":"object","properties":{"type":{"type":"string","enum":["image"]},"url":{"$ref":"#/components/schemas/URL"}},"required":["type","url"]},"URL":{"type":"string","format":"uri","maxLength":2048},"AIAttachmentFile":{"type":"object","properties":{"type":{"type":"string","enum":["file"]},"url":{"$ref":"#/components/schemas/URL"},"filename":{"type":"string","description":"Name of the file."},"contentType":{"type":"string","enum":["application/pdf"]}},"required":["type","url","filename","contentType"]},"AIMessageTask":{"oneOf":[{"type":"object","description":"When the agent is responding to a comment.","properties":{"type":{"type":"string","enum":["respond_to_comment"]},"spaceId":{"type":"string","description":"The ID of the space to respond to the comment in."},"changeRequestId":{"type":"string","description":"The ID of the change request to respond to the comment in."},"commentId":{"type":"string","description":"The ID of the comment to respond to."}},"required":["type","spaceId","commentId"]},{"type":"object","description":"When the agent is reviewing a change request.","properties":{"type":{"type":"string","enum":["review_change_request"]},"spaceId":{"type":"string","description":"The ID of the space the change request is in."},"changeRequestId":{"type":"string","description":"The ID of the change request to review."}},"required":["type","spaceId","changeRequestId"]},{"type":"object","description":"When the agent is implementing a task in a change request.","properties":{"type":{"type":"string","enum":["implement_change_request"]},"spaceId":{"type":"string","description":"The ID of the space the change request is in."},"changeRequestId":{"type":"string","description":"The ID of the change request to implement the task in."}},"required":["type","spaceId","changeRequestId"]}]},"AIMessageResponseMetadata":{"description":"The response that generated this message.","type":"object","properties":{"stopReason":{"type":"string","description":"The reason the response was stopped. If not defined, the response finished normally.","enum":["aborted"]},"id":{"type":"string","description":"The ID of the response that generated this message. It can be undefined if the stream was aborted."},"previous":{"type":"string","description":"The ID of the previous response that this message is based on."}}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}":{"get":{"operationId":"getSiteQuestionAnswerById","summary":"Get a site answer by ID","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteQuestionAnswerId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteQuestionAnswerWithResponse"}}}}}}}}}
```

## GET /orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}/thread

> Get a site answer thread by answer ID

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteQuestionAnswerId":{"name":"siteQuestionAnswerId","in":"path","required":true,"description":"The unique id of the site question answer","schema":{"type":"string"}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"SiteQuestionAnswerWithResponse":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswer"},{"type":"object","properties":{"response":{"$ref":"#/components/schemas/AIMessage"}},"required":["response"]}]},"SiteQuestionAnswer":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer"]},"id":{"type":"string","description":"The ID of the site question answer."},"question":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the parent site question."},"type":{"$ref":"#/components/schemas/SiteQuestionType"}},"required":["id","type"]},"topics":{"type":"array","description":"The IDs of the associated site topics.","items":{"type":"string"}},"input":{"type":"object","required":["text","raw"],"properties":{"text":{"type":"string","description":"Normalized question text for this answer."},"raw":{"type":"string","description":"Raw question text as asked by the user."}}},"thread":{"type":"object","required":["id","previous"],"properties":{"id":{"type":"string","description":"The ID of the thread this answer belongs to."},"previous":{"type":"string","description":"ID of the previous answer in the same thread."}}},"session":{"$ref":"#/components/schemas/SiteInsightsSession"},"feedback":{"type":"object","required":["rating"],"properties":{"rating":{"type":"integer","enum":[-1,1],"description":"Feedback rating provided by the user."}}},"responseId":{"type":"string","description":"The response identifier for this answer."},"language":{"type":"string","description":"ISO language code of the question."},"answered":{"$ref":"#/components/schemas/SiteQuestionAnswerResolution"},"helpfulness":{"$ref":"#/components/schemas/SiteQuestionAnswerHelpfulness"},"relevance":{"$ref":"#/components/schemas/SiteQuestionAnswerRelevance"},"channel":{"oneOf":[{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteCoreChannelType"}},"required":["type"]},{"type":"object","properties":{"type":{"$ref":"#/components/schemas/SiteConfigurableChannelType"},"id":{"type":["string","null"],"description":"ID of the associated site channel when the answer originates from a configurable channel. Null if the channel has been deleted."}},"required":["type","id"]}]},"createdAt":{"$ref":"#/components/schemas/Timestamp"},"updatedAt":{"$ref":"#/components/schemas/Timestamp"},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","question","topics","input","responseId","language","answered","helpfulness","relevance","channel","createdAt","urls"]},"SiteQuestionType":{"type":"string","description":"Type classification of the user question.","enum":["exploring","how-to","troubleshooting","reference","unknown"]},"SiteInsightsSession":{"type":"object","description":"Identifiers for a GitBook site session, used for analytics and adaptive content.","properties":{"visitorId":{"type":"string","description":"GitBook's unique identifier of the visitor."},"sessionId":{"type":"string","description":"GitBook's unique identifier of the visitor's session."}},"required":["visitorId","sessionId"]},"SiteQuestionAnswerResolution":{"type":"string","description":"Whether the response answered the question.","enum":["no","partially","yes"]},"SiteQuestionAnswerHelpfulness":{"type":"string","description":"Helpfulness of the response for the end user need.","enum":["low","medium","high"]},"SiteQuestionAnswerRelevance":{"type":"string","description":"Relevance classification of the user question.","enum":["relevant","spam","off-topic","unclear"]},"SiteCoreChannelType":{"type":"string","enum":["site","embed","api"]},"SiteConfigurableChannelType":{"type":"string","enum":["builtin:slack","builtin:discord","builtin:github"]},"Timestamp":{"type":"string","format":"date-time"},"AIMessage":{"type":"object","properties":{"id":{"type":"string"},"role":{"$ref":"#/components/schemas/AIMessageRole"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/AIMessageStep"}},"task":{"$ref":"#/components/schemas/AIMessageTask"},"response":{"$ref":"#/components/schemas/AIMessageResponseMetadata"}},"required":["id","role","steps"]},"AIMessageRole":{"type":"string","enum":["user","assistant"]},"AIMessageStep":{"type":"object","description":"A step in a message from the AI agent.","properties":{"content":{"$ref":"#/components/schemas/JSONDocument"},"reasoning":{"$ref":"#/components/schemas/JSONDocument"},"toolCalls":{"type":"array","items":{"$ref":"#/components/schemas/AIToolCall"}},"timing":{"type":"object","description":"The timing of the step.","properties":{"reasoning":{"$ref":"#/components/schemas/Timerange"}}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/AIAttachment"}}},"required":["content"]},"JSONDocument":{"type":"object","properties":{"object":{"type":"string","enum":["document"]},"data":{"type":"object","properties":{"schemaVersion":{"description":"The schema version of the document. If undefined, the document is considered to be of the latest schema version.","type":"integer"}},"additionalProperties":true},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksTopLevels"}},"meta":{"type":"object","properties":{"token":{"description":"A content token that can be used to fetch the content referenced in this document from the API.","type":"string"}}}},"required":["object","data","nodes"]},"DocumentBlocksTopLevels":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockOpenAPI"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIOperation"},{"$ref":"#/components/schemas/DocumentBlockOpenAPISchemas"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIWebhook"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockStepper"},{"$ref":"#/components/schemas/DocumentBlockIf"},{"$ref":"#/components/schemas/DocumentBlockColumns"}]},"DocumentBlocksEssentials":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockParagraph"},{"$ref":"#/components/schemas/DocumentBlockHeading"},{"$ref":"#/components/schemas/DocumentBlockListOrdered"},{"$ref":"#/components/schemas/DocumentBlockListUnordered"},{"$ref":"#/components/schemas/DocumentBlockListTasks"},{"$ref":"#/components/schemas/DocumentBlockDivider"}]},"DocumentBlockParagraph":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["paragraph"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentInline"},{"$ref":"#/components/schemas/DocumentText"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"align":{"$ref":"#/components/schemas/TextAlignment"}},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentInline":{"oneOf":[{"$ref":"#/components/schemas/DocumentInlineLink"},{"$ref":"#/components/schemas/DocumentInlineEmoji"},{"$ref":"#/components/schemas/DocumentInlineIcon"},{"$ref":"#/components/schemas/DocumentInlineExpression"},{"$ref":"#/components/schemas/DocumentInlineMath"},{"$ref":"#/components/schemas/DocumentInlineImage"},{"$ref":"#/components/schemas/DocumentInlineAnnotation"},{"$ref":"#/components/schemas/DocumentInlineMention"},{"$ref":"#/components/schemas/DocumentInlineButton"}]},"DocumentInlineLink":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["link"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentText"},{"$ref":"#/components/schemas/DocumentInlineImage"}]}},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentText":{"type":"object","properties":{"object":{"type":"string","enum":["text"]},"key":{"type":"string"},"leaves":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTextLeaf"}}},"required":["object","leaves"]},"DocumentTextLeaf":{"type":"object","properties":{"object":{"type":"string","enum":["leaf"]},"text":{"type":"string"},"marks":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTextMark"}}},"required":["object","text","marks"]},"DocumentTextMark":{"oneOf":[{"$ref":"#/components/schemas/DocumentMarkBold"},{"$ref":"#/components/schemas/DocumentMarkItalic"},{"$ref":"#/components/schemas/DocumentMarkCode"},{"$ref":"#/components/schemas/DocumentMarkKeyboard"},{"$ref":"#/components/schemas/DocumentMarkStrikethrough"},{"$ref":"#/components/schemas/DocumentMarkColor"},{"$ref":"#/components/schemas/DocumentMarkSuperscript"},{"$ref":"#/components/schemas/DocumentMarkSubscript"}]},"DocumentMarkBold":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["bold"]}},"required":["object","type"]},"DocumentMarkItalic":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["italic"]}},"required":["object","type"]},"DocumentMarkCode":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["code"]}},"required":["object","type"]},"DocumentMarkKeyboard":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["keyboard"]}},"required":["object","type"]},"DocumentMarkStrikethrough":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["strikethrough"]}},"required":["object","type"]},"DocumentMarkColor":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["color"]},"data":{"type":"object","properties":{"text":{"$ref":"#/components/schemas/DocumentTextColor"},"background":{"$ref":"#/components/schemas/DocumentTextColor"}},"required":["text","background"]}},"required":["object","type","data"]},"DocumentTextColor":{"type":"string","enum":["default","green","blue","red","orange","yellow","purple","$primary","$info","$success","$warning","$danger"]},"DocumentMarkSuperscript":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["superscript"]}},"required":["object","type"]},"DocumentMarkSubscript":{"type":"object","properties":{"object":{"type":"string","enum":["mark"]},"type":{"type":"string","enum":["subscript"]}},"required":["object","type"]},"DocumentInlineImage":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["inline-image"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"refDark":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"caption":{"type":"string"},"alt":{"type":"string"},"size":{"type":"string","enum":["original","line"]}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"ContentRefURL":{"type":"object","properties":{"kind":{"type":"string","enum":["url"]},"url":{"type":"string"}},"required":["kind","url"]},"ContentRefFile":{"type":"object","properties":{"kind":{"type":"string","enum":["file"]},"file":{"type":"string"},"space":{"description":"ID of the space the file is in. The file is considered as in the current space if none is provided.","type":"string"}},"required":["kind","file"]},"ContentRef":{"description":"A relative reference to content in GitBook.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefPage"},{"$ref":"#/components/schemas/ContentRefAnchor"},{"$ref":"#/components/schemas/ContentRefUser"},{"$ref":"#/components/schemas/ContentRefCollection"},{"$ref":"#/components/schemas/ContentRefSpace"},{"$ref":"#/components/schemas/ContentRefReusableContent"},{"$ref":"#/components/schemas/ContentRefTag"},{"$ref":"#/components/schemas/ContentRefOpenAPI"}]},"ContentRefPage":{"type":"object","properties":{"kind":{"type":"string","enum":["page"]},"page":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"}},"required":["kind","page"]},"ContentRefAnchor":{"type":"object","properties":{"kind":{"type":"string","enum":["anchor"]},"anchor":{"type":"string"},"space":{"description":"ID of the space the page is in. The page is considered as in the current space if none is provided.","type":"string"},"page":{"description":"ID of the page the anchor is in. The anchor is considered as in the current page if none is provided.","type":"string"}},"required":["kind","anchor"]},"ContentRefUser":{"type":"object","properties":{"kind":{"type":"string","enum":["user"]},"user":{"type":"string"}},"required":["kind","user"]},"ContentRefCollection":{"type":"object","properties":{"kind":{"type":"string","enum":["collection"]},"collection":{"type":"string"}},"required":["kind","collection"]},"ContentRefSpace":{"type":"object","properties":{"kind":{"type":"string","enum":["space"]},"space":{"type":"string"}},"required":["kind","space"]},"ContentRefReusableContent":{"type":"object","properties":{"kind":{"type":"string","enum":["reusable-content"]},"reusableContent":{"type":"string"},"space":{"type":"string","description":"The space in which the reusable content is defined. If undefined, the reusable content is assumed to be in the same space as the content reference."}},"required":["kind","reusableContent"]},"ContentRefTag":{"type":"object","properties":{"kind":{"type":"string","enum":["tag"]},"tag":{"type":"string","description":"The slug of the tag, also used as the ID, and references the tags defined on a revision."},"space":{"type":"string","description":"The space in which the tag is defined. If undefined, the tag is assumed to be in the same space as the content reference."}},"required":["kind","tag"]},"ContentRefOpenAPI":{"type":"object","properties":{"kind":{"type":"string","enum":["openapi"]},"spec":{"type":"string","description":"Slug of the OpenAPI specification"}},"required":["kind","spec"]},"DocumentInlineEmoji":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["emoji"]},"key":{"type":"string"},"data":{"type":"object","properties":{"code":{"type":"string"}},"required":["code"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineIcon":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["icon"]},"key":{"type":"string"},"data":{"type":"object","properties":{"icon":{"type":"string"},"color":{"$ref":"#/components/schemas/DocumentTextColor"}},"required":["icon"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineExpression":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["expression"]},"key":{"type":"string"},"data":{"type":"object","properties":{"expression":{"type":"string"}},"required":["expression"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineMath":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["inline-math"]},"key":{"type":"string"},"data":{"type":"object","properties":{"formula":{"type":"string"}},"required":["formula"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineAnnotation":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["annotation"]},"key":{"type":"string"},"fragments":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"type":{"type":"string","enum":["annotation-body"]},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockCode"}]},"minItems":1}},"required":["nodes","type"]}]}},"isVoid":{"type":"boolean","enum":[false]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentText"}},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","fragments","isVoid","nodes"]},"DocumentFragment":{"type":"object","properties":{"object":{"type":"string","enum":["fragment"]},"key":{"type":"string"},"fragment":{"type":"string"},"type":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlock"}}},"required":["object","nodes"]},"DocumentBlock":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockParagraph"},{"$ref":"#/components/schemas/DocumentBlockHeading"},{"$ref":"#/components/schemas/DocumentBlockListOrdered"},{"$ref":"#/components/schemas/DocumentBlockListUnordered"},{"$ref":"#/components/schemas/DocumentBlockListTasks"},{"$ref":"#/components/schemas/DocumentBlockListItem"},{"$ref":"#/components/schemas/DocumentBlockDivider"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockIf"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockImage"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockCodeLine"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockTabsItem"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockOpenAPI"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIOperation"},{"$ref":"#/components/schemas/DocumentBlockOpenAPISchemas"},{"$ref":"#/components/schemas/DocumentBlockOpenAPIWebhook"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockStepper"},{"$ref":"#/components/schemas/DocumentBlockStepperStep"},{"$ref":"#/components/schemas/DocumentBlockColumns"},{"$ref":"#/components/schemas/DocumentBlockColumn"},{"$ref":"#/components/schemas/DocumentBlockUpdates"},{"$ref":"#/components/schemas/DocumentBlockUpdate"}]},"DocumentBlockHeading":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["heading-1","heading-2","heading-3"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentInline"},{"$ref":"#/components/schemas/DocumentText"}]}},"data":{"type":"object","properties":{"id":{"type":"string","pattern":"^[-a-z0-9.+_]+$"},"align":{"$ref":"#/components/schemas/TextAlignment"}}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"TextAlignment":{"type":"string","enum":["start","center","end"]},"DocumentBlockListOrdered":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-ordered"]},"key":{"type":"string"},"data":{"type":"object","properties":{"start":{"type":"number","description":"An integer to start counting from for the list items."}}},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"DocumentBlockListItem":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-item"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockTable"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"checked":{"type":"boolean"}}}},"required":["object","type","nodes"]},"DocumentBlockCode":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["code"]},"key":{"type":"string"},"data":{"type":"object","properties":{"syntax":{"type":"string"},"title":{"type":"string"},"overflow":{"type":"string","default":"scroll","enum":["scroll","wrap"]},"lineNumbers":{"type":"boolean"},"fullWidth":{"type":"boolean"},"expandable":{"type":"boolean"},"collapsedLineCount":{"type":"integer","description":"Number of lines rendered in a code block when it is collapsed","minimum":1,"default":10}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockCodeLine"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"DocumentBlockCodeLine":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["code-line"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentText"},{"$ref":"#/components/schemas/DocumentInlineAnnotation"},{"$ref":"#/components/schemas/DocumentInlineExpression"}]}},"data":{"type":"object","properties":{"highlighted":{"type":"boolean"}}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockHint":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["hint"]},"key":{"type":"string"},"data":{"type":"object","properties":{"style":{"type":"string","enum":["info","warning","danger","success"]},"icon":{"$ref":"#/components/schemas/Icon"}},"required":["style"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksEssentials"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes"]},"Icon":{"type":"string","maxLength":50,"format":"icon","description":"Name of the icon"},"DocumentBlockQuote":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["blockquote"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockQuote"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockMath":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["math"]},"key":{"type":"string"},"data":{"type":"object","properties":{"formula":{"type":"string"}},"required":["formula"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockTable":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["table"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"view":{"oneOf":[{"$ref":"#/components/schemas/DocumentTableViewGrid"},{"$ref":"#/components/schemas/DocumentTableViewCards"}]},"records":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentTableRecord"}},"definition":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/DocumentTableDefinition"}},"fullWidth":{"type":"boolean","description":"Whether to render the block as a full width one"}},"required":["view","records","definition"]},"fragments":{"type":"array","items":{"$ref":"#/components/schemas/DocumentFragment"}}},"required":["object","type","data","isVoid","fragments"]},"DocumentTableViewGrid":{"type":"object","properties":{"type":{"type":"string","enum":["grid"]},"columns":{"type":"array","description":"Ordered list of the definition IDs to display","items":{"type":"string"}},"columnWidths":{"type":"object","description":"Percent width of each column","additionalProperties":{"type":"number"}},"hideHeader":{"type":"boolean","description":"Should we display the header with column titles"},"stickyHeader":{"type":"boolean","description":"Should we keep the table header sticky while the page scrolls"},"useNewSizing":{"type":"boolean","description":"Tables in GitBook originally used a scaled width approach i.e. the width defined\nin columnWidths would be scaled to ensure a 100% width table.\n\nWe later changed this to treat the widths in columnWidths as exact values - they are\nnever scaled. A columnWidth of 50 is rendered as 50px.\n\nIn order to maintain backwards compatibility, we track whether or not we\nuse the new system here.\n\nAll new tables should have this value set to true, older tables will have it set\nto undefined.\n"}},"required":["type","columns","hideHeader"]},"DocumentTableViewCards":{"type":"object","properties":{"type":{"type":"string","enum":["cards"]},"cardSize":{"type":"string","description":"Size of the cards. It indicates how many columns will be used","enum":["medium","large"]},"columns":{"type":"array","description":"Ordered list of the definition IDs to display","items":{"type":"string"}},"targetDefinition":{"type":"string","description":"Definition ID to use as a target link for the card"},"coverDefinition":{"type":"string","description":"Definition ID to use as a cover image"},"coverDefinitionDark":{"type":"string","description":"Definition ID to use as a dark mode cover image"},"hideColumnTitle":{"type":"boolean","description":"Should we display the column title or not"}},"required":["type","columns","cardSize"]},"DocumentTableRecord":{"type":"object","properties":{"orderIndex":{"type":"string"},"values":{"type":"object","additionalProperties":{"oneOf":[{"type":"number"},{"type":["string","null"]},{"type":"boolean"},{"type":"array","items":{"type":"string"}},{"$ref":"#/components/schemas/ContentRef"},{"$ref":"#/components/schemas/DocumentTableImageRecord"}]}}},"required":["orderIndex","values"]},"DocumentTableImageRecord":{"description":"A table record value for image columns, supporting both direct ContentRefs and the additional format with record-level settings.","oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"},{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"}]},"objectFit":{"$ref":"#/components/schemas/CardsImageObjectFit"},"alt":{"type":"string","description":"Alternative text for the cover image"}},"required":["ref"]}]},"CardsImageObjectFit":{"type":"string","description":"Object fit for image display in card views","enum":["contain","fill","cover"]},"DocumentTableDefinition":{"oneOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionText"},{"$ref":"#/components/schemas/DocumentTableDefinitionNumber"},{"$ref":"#/components/schemas/DocumentTableDefinitionCheckbox"},{"$ref":"#/components/schemas/DocumentTableDefinitionFiles"},{"$ref":"#/components/schemas/DocumentTableDefinitionUsers"},{"$ref":"#/components/schemas/DocumentTableDefinitionRating"},{"$ref":"#/components/schemas/DocumentTableDefinitionSelect"},{"$ref":"#/components/schemas/DocumentTableDefinitionContentRef"},{"$ref":"#/components/schemas/DocumentTableDefinitionImage"}]},"DocumentTableDefinitionText":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["text"]},"textAlignment":{"type":"string","enum":["center","right","left"]},"verticalAlignment":{"$ref":"#/components/schemas/VerticalAlignment"}},"required":["type","textAlignment"]}]},"DocumentTableDefinitionBase":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string","description":"Title for the column"}},"required":["id","title"]},"VerticalAlignment":{"type":"string","enum":["top","middle","bottom"]},"DocumentTableDefinitionNumber":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["number"]}},"required":["type"]}]},"DocumentTableDefinitionCheckbox":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["checkbox"]}},"required":["type"]}]},"DocumentTableDefinitionFiles":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["files"]}},"required":["type"]}]},"DocumentTableDefinitionUsers":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["users"]},"multiple":{"type":"boolean"}},"required":["type","multiple"]}]},"DocumentTableDefinitionRating":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["rating"]},"max":{"type":"number"}},"required":["type","max"]}]},"DocumentTableDefinitionSelect":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["select"]},"multiple":{"type":"boolean"},"options":{"type":"array","items":{"$ref":"#/components/schemas/DocumentTableSelectOption"}}},"required":["type","multiple","options"]}]},"DocumentTableSelectOption":{"type":"object","properties":{"value":{"type":"string"},"label":{"type":"string"},"color":{"type":"string"}},"required":["value","label","color"]},"DocumentTableDefinitionContentRef":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["content-ref"]}},"required":["type"]}]},"DocumentTableDefinitionImage":{"allOf":[{"$ref":"#/components/schemas/DocumentTableDefinitionBase"},{"type":"object","properties":{"type":{"type":"string","enum":["image"]}},"required":["type"]}]},"DocumentBlockListUnordered":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-unordered"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"data":{"type":"object","additionalProperties":false},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes"]},"DocumentBlockListTasks":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["list-tasks"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlockListItem"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockDivider":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["divider"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","isVoid","data"]},"DocumentBlockIf":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["if"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlocksTopLevels"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"expression":{"type":"string"}},"required":["expression"]}},"required":["object","type","nodes","data"]},"DocumentBlockImages":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["images"]},"key":{"type":"string"},"data":{"type":"object","properties":{"align":{"type":"string","enum":["center","left","right"]},"fullWidth":{"type":"boolean"},"withFrame":{"type":"boolean"}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockImage"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes","isVoid"]},"DocumentBlockImage":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["image"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"refDark":{"oneOf":[{"$ref":"#/components/schemas/ContentRefURL"},{"$ref":"#/components/schemas/ContentRefFile"}]},"width":{"$ref":"#/components/schemas/Length"},"height":{"$ref":"#/components/schemas/Length"},"alt":{"type":"string"}},"required":["ref"]},"fragments":{"type":"array","items":{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["caption"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockParagraph"}}},"required":["nodes","fragment"]}]}},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","fragments","isVoid"]},"Length":{"oneOf":[{"type":"number"},{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"number"}},"required":["unit","value"]}]},"DocumentBlockFile":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["file"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"}]}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockDrawing":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["drawing"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"}]}}},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockEmbed":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["embed"]},"key":{"type":"string"},"data":{"type":"object","properties":{"url":{"type":"string"},"fullWidth":{"type":"boolean"}},"required":["url"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockExpandable":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["expandable"]},"key":{"type":"string"},"isVoid":{"type":"boolean","enum":[true]},"data":{"type":"object","properties":{"defaultExpanded":{"type":"boolean"}},"additionalProperties":false},"fragments":{"type":"array","items":{"oneOf":[{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["expandable-title"]},"type":{"type":"string","enum":["expandable-title"]},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockParagraph"},"minItems":1,"maxItems":1}},"required":["nodes","fragment","type"]}]},{"allOf":[{"$ref":"#/components/schemas/DocumentFragment"},{"type":"object","properties":{"fragment":{"type":"string","enum":["expandable-body"]},"type":{"type":"string","enum":["expandable-body"]},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockReusableContent"},{"$ref":"#/components/schemas/DocumentBlockIntegration"}]},"minItems":1}},"required":["nodes","fragment","type"]}]}]}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","isVoid","fragments","data"]},"DocumentBlockReusableContent":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["reusable-content"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefReusableContent"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"token":{"description":"A content token that can be used to fetch the reusable content from the API.","type":"string"}}}},"required":["object","type","data","isVoid"]},"DocumentBlockIntegration":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["integration"]},"key":{"type":"string"},"data":{"type":"object","properties":{"integration":{"type":"string","description":"Name of the integration"},"block":{"type":"string","description":"ID of the block in the integration"},"props":{"description":"Properties passed to the block during rendering","$ref":"#/components/schemas/PlainObject"},"action":{"$ref":"#/components/schemas/ContentKitAction"},"url":{"type":"string","description":"URL associated with the content represented by the block.\nThis property is set when creating a block from a URL (unfurl) to ensure\nwe can convert the block back to an embed.\n"},"fullWidth":{"type":"boolean"}},"required":["integration","block","props"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"PlainObject":{"properties":{},"additionalProperties":{"oneOf":[{"$ref":"#/components/schemas/PlainObject"},{"type":"string"},{"type":"boolean"},{"type":"number"},{"type":"array","items":{"oneOf":[{"type":"string"},{"type":"boolean"},{"type":"number"},{"$ref":"#/components/schemas/PlainObject"}]}}]}},"ContentKitAction":{"anyOf":[{"type":"object","description":"Custom action to re-render the block.","properties":{"action":{"type":"string"}},"additionalProperties":true,"required":["action"]},{"$ref":"#/components/schemas/ContentKitDefaultAction"}]},"ContentKitDefaultAction":{"oneOf":[{"type":"object","description":"Action to open an overlay modal defined by \"componentId\".","properties":{"action":{"type":"string","enum":["@ui.modal.open"]},"componentId":{"type":"string"},"props":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","componentId","props"]},{"type":"object","description":"Action when a modal overlay is closed, with a return value to the higher level component in the stack. This action will be triggered on the parent component instance.","properties":{"action":{"type":"string","enum":["@ui.modal.close"]},"returnValue":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","returnValue"]},{"type":"object","description":"Action to open an url.","properties":{"action":{"type":"string","enum":["@ui.url.open"]},"url":{"type":"string"}},"required":["action","url"]},{"type":"object","description":"Action when a link is being unfurled into a block.","properties":{"action":{"type":"string","enum":["@link.unfurl"]},"url":{"type":"string"}},"required":["action","url"]},{"type":"object","description":"Action to update the properties stored in the related node.","properties":{"action":{"type":"string","enum":["@editor.node.updateProps"]},"props":{"$ref":"#/components/schemas/PlainObject"}},"required":["action","props"]}]},"DocumentBlockTabs":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["tabs"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockTabsItem"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"fullWidth":{"type":"boolean"}},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockTabsItem":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["tabs-item"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"}]}},"data":{"type":"object","properties":{"title":{"type":"string"}}},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockContentRef":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["content-ref"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentBlockOpenAPI":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["swagger"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIOperationPointer"},{"type":"object","properties":{"ref":{"oneOf":[{"$ref":"#/components/schemas/ContentRefFile"},{"$ref":"#/components/schemas/ContentRefURL"}]},"expanded":{"type":"boolean","description":"If true, the block is opened by default."},"fullWidth":{"type":"boolean"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPIOperationPointer":{"type":"object","description":"Pointer to an operation in the OpenAPI spec.","properties":{"path":{"type":"string","description":"Path of the operation in the OpenAPI spec."},"method":{"type":"string","description":"HTTP method of the operation in the OpenAPI spec."}},"required":["path","method"]},"DocumentBlockOpenAPIOperation":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-operation"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIOperationPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"DocumentBlockOpenAPISchemas":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-schemas"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPISchemasPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}],"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPISchemasPointer":{"type":"object","description":"Pointer to schemas in the OpenAPI spec.","properties":{"grouped":{"type":"boolean","description":"Whether the schemas are grouped or not.","default":true},"schemas":{"type":"array","description":"List of schemas name from the OpenAPI spec.","items":{"type":"string"}},"title":{"type":"string","description":"Custom title for the schemas block. When not provided, defaults to \"The <SchemaName> object\"."}},"required":["schemas"]},"DocumentBlockOpenAPIWebhook":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["openapi-webhook"]},"key":{"type":"string"},"data":{"allOf":[{"$ref":"#/components/schemas/OpenAPIWebhookPointer"},{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRefOpenAPI"}},"required":["ref"]}]},"isVoid":{"type":"boolean","enum":[true]},"meta":{"type":"object","properties":{"id":{"description":"Unique ID to be used in an URL for the block.","type":"string"}},"required":["id"]}},"required":["object","type","data","isVoid"]},"OpenAPIWebhookPointer":{"type":"object","description":"Pointer to a webhook in the OpenAPI spec.","properties":{"name":{"type":"string","description":"Name of the webhook in the OpenAPI spec."},"method":{"type":"string","description":"HTTP method of the webhook in the OpenAPI spec."}},"required":["name","method"]},"DocumentBlockStepper":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["stepper"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockStepperStep"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{},"additionalProperties":false}},"required":["object","type","nodes"]},"DocumentBlockStepperStep":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["stepper-step"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockExpandable"}]}},"data":{"type":"object","properties":{"icon":{"type":"string"}}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentBlockColumns":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["columns"]},"key":{"type":"string"},"data":{"type":"object","properties":{"fullWidth":{"type":"boolean"}}},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockColumn"}},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","data","nodes","isVoid"]},"DocumentBlockColumn":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["column"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockTable"},{"$ref":"#/components/schemas/DocumentBlockExpandable"},{"$ref":"#/components/schemas/DocumentBlockStepper"}]}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"width":{"$ref":"#/components/schemas/Length"},"verticalAlignment":{"$ref":"#/components/schemas/VerticalAlignment"}},"additionalProperties":false}},"required":["object","type","nodes","data"]},"DocumentBlockUpdates":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["updates"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"$ref":"#/components/schemas/DocumentBlockUpdate"}},"isVoid":{"type":"boolean","enum":[false]},"data":{"type":"object","properties":{"format":{"type":"string","enum":["numeric","full","short"],"default":"full"}},"required":["format"],"additionalProperties":false}},"required":["object","type","nodes","data"]},"DocumentBlockUpdate":{"type":"object","properties":{"object":{"type":"string","enum":["block"]},"type":{"type":"string","enum":["update"]},"key":{"type":"string"},"nodes":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/DocumentBlocksEssentials"},{"$ref":"#/components/schemas/DocumentBlockContentRef"},{"$ref":"#/components/schemas/DocumentBlockCode"},{"$ref":"#/components/schemas/DocumentBlockEmbed"},{"$ref":"#/components/schemas/DocumentBlockFile"},{"$ref":"#/components/schemas/DocumentBlockImages"},{"$ref":"#/components/schemas/DocumentBlockDrawing"},{"$ref":"#/components/schemas/DocumentBlockHint"},{"$ref":"#/components/schemas/DocumentBlockQuote"},{"$ref":"#/components/schemas/DocumentBlockMath"},{"$ref":"#/components/schemas/DocumentBlockIntegration"},{"$ref":"#/components/schemas/DocumentBlockTabs"},{"$ref":"#/components/schemas/DocumentBlockExpandable"}]}},"data":{"type":"object","properties":{"date":{"$ref":"#/components/schemas/Timestamp"},"tags":{"type":"array","description":"Array of tags. Each tag is id'ed by its slug.","items":{"$ref":"#/components/schemas/ContentRefTag"}}},"required":["date"]},"isVoid":{"type":"boolean","enum":[false]}},"required":["object","type","nodes","data"]},"DocumentInlineMention":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["mention"]},"key":{"type":"string"},"data":{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentInlineButton":{"type":"object","properties":{"object":{"type":"string","enum":["inline"]},"type":{"type":"string","enum":["button"]},"key":{"type":"string"},"data":{"allOf":[{"type":"object","properties":{"label":{"type":"string"},"kind":{"type":"string","enum":["primary","secondary"]},"icon":{"$ref":"#/components/schemas/Icon"}},"required":["label","kind"]},{"oneOf":[{"type":"object","properties":{"ref":{"$ref":"#/components/schemas/ContentRef"}},"required":["ref"],"additionalProperties":false},{"type":"object","properties":{"action":{"$ref":"#/components/schemas/DocumentAction"}},"required":["action"],"additionalProperties":false}]}]},"isVoid":{"type":"boolean","enum":[true]}},"required":["object","type","data","isVoid"]},"DocumentAction":{"type":"object","oneOf":[{"type":"object","properties":{"action":{"type":"string","enum":["search"]},"query":{"type":"string"}},"required":["action"],"additionalProperties":false},{"type":"object","properties":{"action":{"type":"string","enum":["ask"]},"query":{"type":"string"}},"required":["action"],"additionalProperties":false}]},"AIToolCall":{"oneOf":[{"$ref":"#/components/schemas/AIToolCallGetPageContent"},{"$ref":"#/components/schemas/AIToolCallGetRecordContent"},{"$ref":"#/components/schemas/AIToolCallGetPages"},{"$ref":"#/components/schemas/AIToolCallGetReusableContents"},{"$ref":"#/components/schemas/AIToolCallSearch"},{"$ref":"#/components/schemas/AIToolCallEditPage"},{"$ref":"#/components/schemas/AIToolCallCreatePage"},{"$ref":"#/components/schemas/AIToolCallDeletePage"},{"$ref":"#/components/schemas/AIToolCallRenamePage"},{"$ref":"#/components/schemas/AIToolCallMovePage"},{"$ref":"#/components/schemas/AIToolCallListModifiedPages"},{"$ref":"#/components/schemas/AIToolCallGetPageDiff"},{"$ref":"#/components/schemas/AIToolCallCreateReusableContent"},{"$ref":"#/components/schemas/AIToolCallEditReusableContent"},{"$ref":"#/components/schemas/AIToolCallGetReusableContent"},{"$ref":"#/components/schemas/AIToolCallCreateChangeRequest"},{"$ref":"#/components/schemas/AIToolCallComment"},{"$ref":"#/components/schemas/AIToolCallReplyToComment"},{"$ref":"#/components/schemas/AIToolCallSubmitChangeRequestReview"},{"$ref":"#/components/schemas/AIToolCallMCP"},{"$ref":"#/components/schemas/AIToolCallOther"}]},"AIToolCallGetPageContent":{"type":"object","properties":{"tool":{"type":"string","enum":["getPageContent"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The ID of the revision within which the page content is being fetched."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page","revisionId"]},"ChangedRevisionPage":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/RevisionPageType"},"title":{"type":"string"},"path":{"type":"string"}},"required":["id","type","title"]},"RevisionPageType":{"type":"string","enum":["document","group","link","computed"]},"AIToolCallGetRecordContent":{"type":"object","description":"Tool to read the body of an external record.","properties":{"tool":{"type":"string","enum":["getRecordContent"]},"siteId":{"type":"string","description":"The ID of the site owning the context record."},"recordId":{"type":"string","description":"The ID of the context record."},"title":{"type":"string","description":"The title of the record."},"url":{"type":"string","format":"uri","description":"URL of the record in the source system."}},"required":["tool","siteId","recordId","title"]},"AIToolCallGetPages":{"type":"object","properties":{"tool":{"type":"string","enum":["getPages"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The revision ID of the space."}},"required":["tool","spaceId","revisionId"]},"AIToolCallGetReusableContents":{"type":"object","properties":{"tool":{"type":"string","enum":["getReusableContents"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The revision ID of the space."}},"required":["tool","spaceId","revisionId"]},"AIToolCallSearch":{"type":"object","description":"Tool to search for content","properties":{"tool":{"type":"string","enum":["search"]},"query":{"type":"string","description":"The query that has been searched for."},"results":{"type":"array","items":{"$ref":"#/components/schemas/AIToolCallSearchResult"}}},"required":["tool","query","results"]},"AIToolCallSearchResult":{"description":"Result of a search","oneOf":[{"$ref":"#/components/schemas/AIToolCallSearchResultPage"},{"$ref":"#/components/schemas/AIToolCallSearchResultRecord"}],"discriminator":{"propertyName":"type"}},"AIToolCallSearchResultPage":{"type":"object","title":"Page result","description":"Result of a search matching a page.","properties":{"type":{"type":"string","enum":["page"]},"spaceId":{"type":"string","description":"The ID of the space"},"pageId":{"type":"string","description":"The ID of the page"},"revisionId":{"type":"string","description":"The revision ID of the result"},"anchor":{"type":"string","description":"The anchor of the result"},"title":{"type":"string","description":"The title of the result"},"description":{"type":"string","description":"The description of the result"}},"required":["type","spaceId","pageId","revisionId","title"]},"AIToolCallSearchResultRecord":{"type":"object","title":"Site context record result","description":"Result of a search matching a site context record.","properties":{"type":{"type":"string","enum":["record"]},"siteId":{"type":"string","description":"The ID of the site owning the context record"},"recordId":{"type":"string","description":"The ID of the context record"},"title":{"type":"string","description":"The title of the record"},"description":{"type":"string","description":"The description of the record"},"url":{"type":"string","format":"uri","description":"URL of the record in its original source"}},"required":["type","siteId","recordId","title"]},"AIToolCallEditPage":{"type":"object","properties":{"tool":{"type":"string","enum":["editPage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallCreatePage":{"type":"object","properties":{"tool":{"type":"string","enum":["createPage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallDeletePage":{"type":"object","properties":{"tool":{"type":"string","enum":["deletePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallRenamePage":{"type":"object","properties":{"tool":{"type":"string","enum":["renamePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"},"title":{"type":"string","description":"The new title of the page."}},"required":["tool","spaceId","page","title"]},"AIToolCallMovePage":{"type":"object","properties":{"tool":{"type":"string","enum":["movePage"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"},"to":{"$ref":"#/components/schemas/ChangedRevisionPage"},"moveType":{"type":"string","description":"Indicates how the page was moved relative to the \"to\" page.\n- `within`: moved as the last child of the target page (or to the root when `to` is omitted)\n- `before`: moved directly before the target page\n- `after`: moved directly after the target page\n","enum":["within","before","after"]}},"required":["tool","spaceId","page","moveType"]},"AIToolCallListModifiedPages":{"type":"object","properties":{"tool":{"type":"string","enum":["listModifiedPages"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."}},"required":["tool","spaceId"]},"AIToolCallGetPageDiff":{"type":"object","properties":{"tool":{"type":"string","enum":["getPageDiff"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"page":{"$ref":"#/components/schemas/ChangedRevisionPage"}},"required":["tool","spaceId","page"]},"AIToolCallCreateReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["createReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent"]},"ChangedRevisionReusableContent":{"type":"object","properties":{"id":{"type":"string"},"title":{"type":"string"},"document":{"type":"string"}},"required":["id","title"]},"AIToolCallEditReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["editReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being edited."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent"]},"AIToolCallGetReusableContent":{"type":"object","properties":{"tool":{"type":"string","enum":["getReusableContent"]},"spaceId":{"type":"string","description":"The ID of the space being accessed."},"revisionId":{"type":"string","description":"The ID of the revision within which the reusable content is being fetched."},"reusableContent":{"$ref":"#/components/schemas/ChangedRevisionReusableContent"}},"required":["tool","spaceId","reusableContent","revisionId"]},"AIToolCallCreateChangeRequest":{"type":"object","properties":{"tool":{"type":"string","enum":["createChangeRequest"]},"spaceId":{"type":"string","description":"The ID of the space the change request belongs to."},"action":{"type":"string","enum":["create","update"]},"changeRequest":{"type":"object","properties":{"id":{"type":"string","description":"The unique identifier of the change request."},"number":{"type":"number","description":"Incremental identifier of the change request."},"subject":{"type":"string","description":"A brief summary of the change request."}},"required":["id","number","subject"]}},"required":["tool","spaceId","action","changeRequest"]},"AIToolCallComment":{"type":"object","properties":{"tool":{"type":"string","enum":["comment"]},"spaceId":{"type":"string","description":"The ID of the space being commented."},"page":{"description":"The page being commented.","$ref":"#/components/schemas/ChangedRevisionPage"},"commentId":{"type":"string","description":"The ID of the comment being posted."}},"required":["tool","spaceId","commentId"]},"AIToolCallReplyToComment":{"type":"object","properties":{"tool":{"type":"string","enum":["replyToComment"]},"spaceId":{"type":"string","description":"The ID of the space being commented."},"page":{"description":"The page being commented.","$ref":"#/components/schemas/ChangedRevisionPage"},"commentId":{"type":"string","description":"The ID of the comment being replied to."},"replyId":{"type":"string","description":"The ID of the reply being posted."}},"required":["tool","spaceId","commentId","replyId"]},"AIToolCallSubmitChangeRequestReview":{"type":"object","properties":{"tool":{"type":"string","enum":["submitChangeRequestReview"]},"spaceId":{"type":"string","description":"The ID of the space where the review was submitted."},"changeRequestId":{"type":"string","description":"The ID of the change request being reviewed."},"status":{"$ref":"#/components/schemas/ChangeRequestReviewStatus","description":"Result of the review."},"reviewId":{"type":"string","description":"Identifier of the review that was created."},"commentId":{"type":"string","description":"Identifier of the comment that was created as part of the review."}},"required":["tool","spaceId","changeRequestId","status","reviewId","commentId"]},"ChangeRequestReviewStatus":{"type":"string","description":"Status of a change request review.","enum":["changes-requested","approved"]},"AIToolCallMCP":{"type":"object","description":"Tool called from an MCP server","properties":{"tool":{"type":"string","enum":["mcp"]},"mcpServerId":{"type":"string","description":"The ID of the MCP server that has been called."},"mcpToolName":{"type":"string","description":"The name of the tool that has been called."},"mcpToolTitle":{"type":"string","description":"The title of the tool that has been called."}},"required":["tool","mcpServerId","mcpToolName"]},"AIToolCallOther":{"type":"object","description":"Any tool call that is unknown by GitBook","properties":{"tool":{"type":"string","enum":["other"]},"summary":{"$ref":"#/components/schemas/AIToolCallOtherSummary"}},"required":["tool","summary"]},"AIToolCallOtherSummary":{"type":"object","description":"Summary of a generic tool call.","properties":{"icon":{"$ref":"#/components/schemas/Icon"},"text":{"type":"string","description":"Text to display to the user to describe the tool call."}},"required":["icon","text"]},"Timerange":{"type":"object","properties":{"start":{"$ref":"#/components/schemas/Timestamp"},"end":{"$ref":"#/components/schemas/Timestamp"}},"required":["start","end"]},"AIAttachment":{"oneOf":[{"$ref":"#/components/schemas/AIAttachmentImage"},{"$ref":"#/components/schemas/AIAttachmentFile"}]},"AIAttachmentImage":{"type":"object","properties":{"type":{"type":"string","enum":["image"]},"url":{"$ref":"#/components/schemas/URL"}},"required":["type","url"]},"URL":{"type":"string","format":"uri","maxLength":2048},"AIAttachmentFile":{"type":"object","properties":{"type":{"type":"string","enum":["file"]},"url":{"$ref":"#/components/schemas/URL"},"filename":{"type":"string","description":"Name of the file."},"contentType":{"type":"string","enum":["application/pdf"]}},"required":["type","url","filename","contentType"]},"AIMessageTask":{"oneOf":[{"type":"object","description":"When the agent is responding to a comment.","properties":{"type":{"type":"string","enum":["respond_to_comment"]},"spaceId":{"type":"string","description":"The ID of the space to respond to the comment in."},"changeRequestId":{"type":"string","description":"The ID of the change request to respond to the comment in."},"commentId":{"type":"string","description":"The ID of the comment to respond to."}},"required":["type","spaceId","commentId"]},{"type":"object","description":"When the agent is reviewing a change request.","properties":{"type":{"type":"string","enum":["review_change_request"]},"spaceId":{"type":"string","description":"The ID of the space the change request is in."},"changeRequestId":{"type":"string","description":"The ID of the change request to review."}},"required":["type","spaceId","changeRequestId"]},{"type":"object","description":"When the agent is implementing a task in a change request.","properties":{"type":{"type":"string","enum":["implement_change_request"]},"spaceId":{"type":"string","description":"The ID of the space the change request is in."},"changeRequestId":{"type":"string","description":"The ID of the change request to implement the task in."}},"required":["type","spaceId","changeRequestId"]}]},"AIMessageResponseMetadata":{"description":"The response that generated this message.","type":"object","properties":{"stopReason":{"type":"string","description":"The reason the response was stopped. If not defined, the response finished normally.","enum":["aborted"]},"id":{"type":"string","description":"The ID of the response that generated this message. It can be undefined if the stream was aborted."},"previous":{"type":"string","description":"The ID of the previous response that this message is based on."}}}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}/thread":{"get":{"operationId":"getSiteQuestionAnswerThreadById","summary":"Get a site answer thread by answer ID","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteQuestionAnswerId"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerWithResponse"}}}}}}}}}}
```

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

> List the sources for an answer

```json
{"openapi":"3.1.0","info":{"title":"GitBook API","version":"0.0.1-beta"},"tags":[{"name":"site-questions","description":"Inspect the canonical questions asked on your site, the generated answers linked to each question, and the sources used for each answer.\n\n{% openapi-schemas spec=\"gitbook\" schemas=\"SiteQuestion,SiteQuestionAnswer,SiteQuestionAnswerWithResponse,SiteQuestionAnswerSource\" grouped=\"false\" %}\n    The Site Questions objects\n{% endopenapi-schemas %}\n"}],"servers":[{"url":"{host}/v1","variables":{"host":{"default":"https://api.gitbook.com"}}}],"security":[{"user":[]}],"components":{"securitySchemes":{"user":{"type":"http","scheme":"bearer"}},"parameters":{"organizationId":{"name":"organizationId","in":"path","required":true,"description":"The unique id of the organization","schema":{"$ref":"#/components/schemas/EntityId"}},"siteId":{"name":"siteId","in":"path","required":true,"description":"The unique id of the site","schema":{"type":"string"}},"siteQuestionAnswerId":{"name":"siteQuestionAnswerId","in":"path","required":true,"description":"The unique id of the site question answer","schema":{"type":"string"}},"listPage":{"name":"page","in":"query","description":"Identifier of the page results to fetch.","schema":{"type":"string"}},"listLimit":{"name":"limit","in":"query","description":"The number of results per page","schema":{"type":"number","minimum":0,"maximum":1000}}},"schemas":{"EntityId":{"type":"string","pattern":"^[a-zA-Z0-9_-]+$","description":"A unique entity identifier"},"List":{"type":"object","properties":{"next":{"type":"object","properties":{"page":{"type":"string","description":"Unique identifier to query the next results page"}},"required":["page"]},"count":{"type":"number","description":"Total count of objects in the list"}}},"SiteQuestionAnswerSource":{"oneOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourcePage"},{"$ref":"#/components/schemas/SiteQuestionAnswerSourceRecord"}],"discriminator":{"propertyName":"type"}},"SiteQuestionAnswerSourcePage":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourceBase"},{"type":"object","title":"Page source","description":"Source data pointing to a page used for a site question answer.","properties":{"type":{"type":"string","enum":["page"]},"space":{"type":"string","description":"The space ID of the source page."},"revision":{"type":"string","description":"The revision ID used for this source page."},"page":{"type":"string","description":"The page ID of the source page."}},"required":["type","space","revision","page"]}]},"SiteQuestionAnswerSourceBase":{"type":"object","properties":{"object":{"type":"string","enum":["site-question-answer-source"]},"id":{"type":"string","description":"The ID of the source."},"weight":{"type":"number","description":"Relative weight of this source in the generated answer."},"title":{"type":"string","description":"The title of the source."},"urls":{"type":"object","description":"URLs associated with the site question answer.","properties":{"location":{"type":"string","format":"uri","description":"URL of the site question answer in the API."}},"required":["location"]}},"required":["object","id","title","weight","urls"]},"SiteQuestionAnswerSourceRecord":{"allOf":[{"$ref":"#/components/schemas/SiteQuestionAnswerSourceBase"},{"type":"object","properties":{"type":{"type":"string","enum":["record"]},"record":{"type":"string","description":"The site context record ID."},"connector":{"$ref":"#/components/schemas/ContextConnector"}},"required":["type","record"]}]},"ContextConnector":{"oneOf":[{"type":"string","description":"Integration source","pattern":"^integration:[^:]+$"},{"type":"string","description":"Builtin sources","enum":["builtin:email","builtin:api","builtin:website","builtin:youtube","builtin:github-discussions","builtin:github-issues","builtin:intercom"]}]}}},"paths":{"/orgs/{organizationId}/sites/{siteId}/answers/{siteQuestionAnswerId}/sources":{"get":{"operationId":"listSiteQuestionAnswerSources","summary":"List the sources for an answer","tags":["site-questions"],"parameters":[{"$ref":"#/components/parameters/organizationId"},{"$ref":"#/components/parameters/siteId"},{"$ref":"#/components/parameters/siteQuestionAnswerId"},{"$ref":"#/components/parameters/listPage"},{"$ref":"#/components/parameters/listLimit"}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"allOf":[{"$ref":"#/components/schemas/List"},{"type":"object","required":["items"],"properties":{"items":{"type":"array","items":{"$ref":"#/components/schemas/SiteQuestionAnswerSource"}}}}]}}}}}}}}}
```