The API token used for authenticating the request. This must be passed as a header parameter. To generate an API token, go to Settings > Knowledge base portal > API tokens. This token must correspond to a valid workspace and permission level.
Feedback payload. entityId ties the feedback to a previous AI search response; isLiked is a thumbs-up/down signal.
Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.
{
"entity_id": "",
"is_liked": false,
"comments": "",
"notify_me_about_changes": false,
"feedback_provider_email": "",
"additional_feedback_info": {
"need_more_information": false,
"difficult_to_understand": false,
"irrelevant_content": false,
"incorrect_source_reference": false,
"missing_information": false,
"dont_like_style": false,
"others": false,
"comments": false
},
"feedback_sub_type": 0
}Analytics ID returned by the ask-eddy response. Required to associate feedback with an ask-eddy query.
Set to true if the user liked the AI response, and false if the user disliked the response.
Optional user-provided feedback or suggestions about the AI response.
Set to true if the user wants to be notified when there is a response to their feedback.
Email address of the user submitting the feedback. Required if notify_me_about_changes is set to true.
Additional details about the user’s feedback. Helps categorize user feedback and respond effectively.
User needs more information than what was provided in the AI response.
The AI response was difficult for the user to understand.
The AI response was not relevant to the user's query.
The source references in the AI response were incorrect or misleading.
Important information was missing from the AI response.
The user did not like the style of the AI response.
The user's feedback does not fall under the predefined categories.
Indicates whether the user has provided additional comments.
Set to 0 if the user did not receive a response to their query. Set to 1 if they received a response but were not satisfied with it.
Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.
{
"entity_id": "",
"is_liked": false,
"comments": "",
"notify_me_about_changes": false,
"feedback_provider_email": "",
"additional_feedback_info": {
"need_more_information": false,
"difficult_to_understand": false,
"irrelevant_content": false,
"incorrect_source_reference": false,
"missing_information": false,
"dont_like_style": false,
"others": false,
"comments": false
},
"feedback_sub_type": 0
}Analytics ID returned by the ask-eddy response. Required to associate feedback with an ask-eddy query.
Set to true if the user liked the AI response, and false if the user disliked the response.
Optional user-provided feedback or suggestions about the AI response.
Set to true if the user wants to be notified when there is a response to their feedback.
Email address of the user submitting the feedback. Required if notify_me_about_changes is set to true.
Additional details about the user’s feedback. Helps categorize user feedback and respond effectively.
User needs more information than what was provided in the AI response.
The AI response was difficult for the user to understand.
The AI response was not relevant to the user's query.
The source references in the AI response were incorrect or misleading.
Important information was missing from the AI response.
The user did not like the style of the AI response.
The user's feedback does not fall under the predefined categories.
Indicates whether the user has provided additional comments.
Set to 0 if the user did not receive a response to their query. Set to 1 if they received a response but were not satisfied with it.
Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.
{
"entity_id": "",
"is_liked": false,
"comments": "",
"notify_me_about_changes": false,
"feedback_provider_email": "",
"additional_feedback_info": {
"need_more_information": false,
"difficult_to_understand": false,
"irrelevant_content": false,
"incorrect_source_reference": false,
"missing_information": false,
"dont_like_style": false,
"others": false,
"comments": false
},
"feedback_sub_type": 0
}Analytics ID returned by the ask-eddy response. Required to associate feedback with an ask-eddy query.
Set to true if the user liked the AI response, and false if the user disliked the response.
Optional user-provided feedback or suggestions about the AI response.
Set to true if the user wants to be notified when there is a response to their feedback.
Email address of the user submitting the feedback. Required if notify_me_about_changes is set to true.
Additional details about the user’s feedback. Helps categorize user feedback and respond effectively.
User needs more information than what was provided in the AI response.
The AI response was difficult for the user to understand.
The AI response was not relevant to the user's query.
The source references in the AI response were incorrect or misleading.
Important information was missing from the AI response.
The user did not like the style of the AI response.
The user's feedback does not fall under the predefined categories.
Indicates whether the user has provided additional comments.
Set to 0 if the user did not receive a response to their query. Set to 1 if they received a response but were not satisfied with it.
Resync an API reference with specific apiReferenceId projectVersionId, userId and a spec file url or a file type.
{
"entity_id": "",
"is_liked": false,
"comments": "",
"notify_me_about_changes": false,
"feedback_provider_email": "",
"additional_feedback_info": {
"need_more_information": false,
"difficult_to_understand": false,
"irrelevant_content": false,
"incorrect_source_reference": false,
"missing_information": false,
"dont_like_style": false,
"others": false,
"comments": false
},
"feedback_sub_type": 0
}Analytics ID returned by the ask-eddy response. Required to associate feedback with an ask-eddy query.
Set to true if the user liked the AI response, and false if the user disliked the response.
Optional user-provided feedback or suggestions about the AI response.
Set to true if the user wants to be notified when there is a response to their feedback.
Email address of the user submitting the feedback. Required if notify_me_about_changes is set to true.
Additional details about the user’s feedback. Helps categorize user feedback and respond effectively.
User needs more information than what was provided in the AI response.
The AI response was difficult for the user to understand.
The AI response was not relevant to the user's query.
The source references in the AI response were incorrect or misleading.
Important information was missing from the AI response.
The user did not like the style of the AI response.
The user's feedback does not fall under the predefined categories.
Indicates whether the user has provided additional comments.
Set to 0 if the user did not receive a response to their query. Set to 1 if they received a response but were not satisfied with it.
Operation succeeded. Inspect the response envelope's success flag and the result/data payload.
This is sample response for this endpoint.
{
"extension_data": null,
"context": null,
"success": true,
"errors": [],
"warnings": [],
"information": [],
"feature_explorer_status": null,
"custom_page_element": null
}Canonical Portal API response envelope. Every endpoint's response either is a Document360.Core.Messages.Core.BaseResponse or derives from one. Carries the success flag plus arrays of structured errors, warnings, and informational messages — the whole of which the SPA inspects to render success/error UI.
Round-trip extension data for forward-compat fields not modelled here.
Optional response-level context (e.g. caller reference for log correlation).
Round-trip extension data for forward-compat fields.
Optional opaque ID supplied by the caller, echoed back in audit logs and responses.
True when the request succeeded. Always inspect this before consuming the success-shape fields.
List of structured errors. Populated when Document360.Core.Messages.Core.BaseResponse.success is false.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
List of non-fatal warnings — the request succeeded, but with caveats worth surfacing to the user.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Informational messages — context the SPA might use (e.g. fallback logic, skipped operations).
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Onboarding/feature-explorer status payload, surfaced via response interceptors.
Possible values: "all" = All, "createKnowledgeBaseArticle" = CreateKnowledgeBaseArticle, "inviteTeamMembers" = InviteTeamMembers, "extensions" = Extensions, "homePageBuilder" = HomePageBuilder, "advanced" = Advanced
Possible values: "all" = All, "publishArticle" = PublishArticle, "addCategory" = AddCategory, "articleImport" = ArticleImport, "inviteTeamMember" = InviteTeamMember, "createRoles" = CreateRoles, "inviteReaders" = InviteReaders, "addExtensions" = AddExtensions, "publishLandingPage" = PublishLandingPage, "addContributors" = AddContributors, "addWorkFlow" = AddWorkFlow, "compareVersions" = CompareVersions, "articleReviewReminder" = ArticleReviewReminder, "addFiles" = AddFiles, "seo" = SEO, "design" = Design, "navigations" = Navigations, "customCSSandJS" = CustomCSSandJS, "smartBars" = SmartBars, "setCookieConsent" = SetCookieConsent, "apiTokens" = APITokens, "projectBackup" = ProjectBackup, "addCustomDomain" = AddCustomDomain, "createSecurityGroup" = CreateSecurityGroup, "auditing" = Auditing, "analytics" = Analytics, "ipRestriction" = IPRestriction
Possible values: "basic" = Basic, "contentRole" = ContentRole, "portalRole" = PortalRole
Possible values: "all" = All, "createKnowledgeBaseArticle" = CreateKnowledgeBaseArticle, "inviteTeamMembers" = InviteTeamMembers, "extensions" = Extensions, "homePageBuilder" = HomePageBuilder, "advanced" = Advanced
Possible values: "all" = All, "publishArticle" = PublishArticle, "addCategory" = AddCategory, "articleImport" = ArticleImport, "inviteTeamMember" = InviteTeamMember, "createRoles" = CreateRoles, "inviteReaders" = InviteReaders, "addExtensions" = AddExtensions, "publishLandingPage" = PublishLandingPage, "addContributors" = AddContributors, "addWorkFlow" = AddWorkFlow, "compareVersions" = CompareVersions, "articleReviewReminder" = ArticleReviewReminder, "addFiles" = AddFiles, "seo" = SEO, "design" = Design, "navigations" = Navigations, "customCSSandJS" = CustomCSSandJS, "smartBars" = SmartBars, "setCookieConsent" = SetCookieConsent, "apiTokens" = APITokens, "projectBackup" = ProjectBackup, "addCustomDomain" = AddCustomDomain, "createSecurityGroup" = CreateSecurityGroup, "auditing" = Auditing, "analytics" = Analytics, "ipRestriction" = IPRestriction
UI element directive returned alongside the response when the SPA should render an inline tip or banner.
Possible values: "homePageBody" = HomePageBody, "documentationPageBody" = DocumentationPageBody, "navigationPageBody" = NavigationPageBody, "customPageBody" = CustomPageBody, "heroSection" = HeroSection, "customCodeSection" = CustomCodeSection, "imageWithTextSection" = ImageWithTextSection, "multiColumnCardSection" = MultiColumnCardSection, "richTextSection" = RichTextSection, "widgetSection" = WidgetSection, "actionCardElement" = ActionCardElement, "infoCardElement" = InfoCardElement, "groupClickableElement" = GroupClickableElement, "clickableElement" = ClickableElement, "customHTMLInputElement" = CustomHTMLInputElement, "customCSSInputElement" = CustomCSSInputElement, "imageElement" = ImageElement, "headingTextElement" = HeadingTextElement, "inputTextboxElement" = InputTextboxElement, "textAreaElement" = TextAreaElement, "topListWidgetElement" = TopListWidgetElement, "imageWithFormSection" = ImageWithFormSection, "formElement" = FormElement, "navigationElement" = NavigationElement, "containerSection" = ContainerSection, "articleHeaderElement" = ArticleHeaderElement, "articleContentElement" = ArticleContentElement, "treeElement" = TreeElement, "feedbackElement" = FeedbackElement, "commentsElement" = CommentsElement, "articleSummary" = ArticleSummary, "multiColumnCardEditableSection" = MultiColumnCardEditableSection, "multiColumnCardSectionV2" = MultiColumnCardSectionV2, "tabSection" = TabSection, "tabItemElement" = TabItemElement, "widgetCardElement" = WidgetCardElement, "acknowledgementInfoElement" = AcknowledgementInfoElement, "acknowledgementSubmitElement" = AcknowledgementSubmitElement, "guideNodeElement" = GuideNodeElement, "guideTextAreaElement" = GuideTextAreaElement, "guideHeadingTextElement" = GuideHeadingTextElement, "guideGroupClickableElement" = GuideGroupClickableElement, "guideImageElement" = GuideImageElement, "guideButtonElement" = GuideButtonElement, "guideRadioButtonElement" = GuideRadioButtonElement, "guideCheckboxElement" = GuideCheckboxElement, "guideDropdownElement" = GuideDropdownElement
The request body or query parameters failed validation. Inspect errors[].description for the offending fields.
Kindly ensure the analyticsId is not empty and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "AnalyticsId should not be empty",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly ensure the projectDocumentVersionId is not empty and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "ProjectDocumentVersionId should not be empty",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Kindly ensure the languageCode is not empty and perform the task again.
{
"extension_data": null,
"success": false,
"errors": [
{
"extension_data": null,
"stack_trace": null,
"description": "LanguageCode should not be empty",
"error_code": null,
"custom_data": null
}
],
"warnings": [],
"information": []
}Canonical Portal API response envelope. Every endpoint's response either is a Document360.Core.Messages.Core.BaseResponse or derives from one. Carries the success flag plus arrays of structured errors, warnings, and informational messages — the whole of which the SPA inspects to render success/error UI.
Round-trip extension data for forward-compat fields not modelled here.
Optional response-level context (e.g. caller reference for log correlation).
Round-trip extension data for forward-compat fields.
Optional opaque ID supplied by the caller, echoed back in audit logs and responses.
True when the request succeeded. Always inspect this before consuming the success-shape fields.
List of structured errors. Populated when Document360.Core.Messages.Core.BaseResponse.success is false.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
List of non-fatal warnings — the request succeeded, but with caveats worth surfacing to the user.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Informational messages — context the SPA might use (e.g. fallback logic, skipped operations).
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Onboarding/feature-explorer status payload, surfaced via response interceptors.
Possible values: "all" = All, "createKnowledgeBaseArticle" = CreateKnowledgeBaseArticle, "inviteTeamMembers" = InviteTeamMembers, "extensions" = Extensions, "homePageBuilder" = HomePageBuilder, "advanced" = Advanced
Possible values: "all" = All, "publishArticle" = PublishArticle, "addCategory" = AddCategory, "articleImport" = ArticleImport, "inviteTeamMember" = InviteTeamMember, "createRoles" = CreateRoles, "inviteReaders" = InviteReaders, "addExtensions" = AddExtensions, "publishLandingPage" = PublishLandingPage, "addContributors" = AddContributors, "addWorkFlow" = AddWorkFlow, "compareVersions" = CompareVersions, "articleReviewReminder" = ArticleReviewReminder, "addFiles" = AddFiles, "seo" = SEO, "design" = Design, "navigations" = Navigations, "customCSSandJS" = CustomCSSandJS, "smartBars" = SmartBars, "setCookieConsent" = SetCookieConsent, "apiTokens" = APITokens, "projectBackup" = ProjectBackup, "addCustomDomain" = AddCustomDomain, "createSecurityGroup" = CreateSecurityGroup, "auditing" = Auditing, "analytics" = Analytics, "ipRestriction" = IPRestriction
Possible values: "basic" = Basic, "contentRole" = ContentRole, "portalRole" = PortalRole
Possible values: "all" = All, "createKnowledgeBaseArticle" = CreateKnowledgeBaseArticle, "inviteTeamMembers" = InviteTeamMembers, "extensions" = Extensions, "homePageBuilder" = HomePageBuilder, "advanced" = Advanced
Possible values: "all" = All, "publishArticle" = PublishArticle, "addCategory" = AddCategory, "articleImport" = ArticleImport, "inviteTeamMember" = InviteTeamMember, "createRoles" = CreateRoles, "inviteReaders" = InviteReaders, "addExtensions" = AddExtensions, "publishLandingPage" = PublishLandingPage, "addContributors" = AddContributors, "addWorkFlow" = AddWorkFlow, "compareVersions" = CompareVersions, "articleReviewReminder" = ArticleReviewReminder, "addFiles" = AddFiles, "seo" = SEO, "design" = Design, "navigations" = Navigations, "customCSSandJS" = CustomCSSandJS, "smartBars" = SmartBars, "setCookieConsent" = SetCookieConsent, "apiTokens" = APITokens, "projectBackup" = ProjectBackup, "addCustomDomain" = AddCustomDomain, "createSecurityGroup" = CreateSecurityGroup, "auditing" = Auditing, "analytics" = Analytics, "ipRestriction" = IPRestriction
UI element directive returned alongside the response when the SPA should render an inline tip or banner.
Possible values: "homePageBody" = HomePageBody, "documentationPageBody" = DocumentationPageBody, "navigationPageBody" = NavigationPageBody, "customPageBody" = CustomPageBody, "heroSection" = HeroSection, "customCodeSection" = CustomCodeSection, "imageWithTextSection" = ImageWithTextSection, "multiColumnCardSection" = MultiColumnCardSection, "richTextSection" = RichTextSection, "widgetSection" = WidgetSection, "actionCardElement" = ActionCardElement, "infoCardElement" = InfoCardElement, "groupClickableElement" = GroupClickableElement, "clickableElement" = ClickableElement, "customHTMLInputElement" = CustomHTMLInputElement, "customCSSInputElement" = CustomCSSInputElement, "imageElement" = ImageElement, "headingTextElement" = HeadingTextElement, "inputTextboxElement" = InputTextboxElement, "textAreaElement" = TextAreaElement, "topListWidgetElement" = TopListWidgetElement, "imageWithFormSection" = ImageWithFormSection, "formElement" = FormElement, "navigationElement" = NavigationElement, "containerSection" = ContainerSection, "articleHeaderElement" = ArticleHeaderElement, "articleContentElement" = ArticleContentElement, "treeElement" = TreeElement, "feedbackElement" = FeedbackElement, "commentsElement" = CommentsElement, "articleSummary" = ArticleSummary, "multiColumnCardEditableSection" = MultiColumnCardEditableSection, "multiColumnCardSectionV2" = MultiColumnCardSectionV2, "tabSection" = TabSection, "tabItemElement" = TabItemElement, "widgetCardElement" = WidgetCardElement, "acknowledgementInfoElement" = AcknowledgementInfoElement, "acknowledgementSubmitElement" = AcknowledgementSubmitElement, "guideNodeElement" = GuideNodeElement, "guideTextAreaElement" = GuideTextAreaElement, "guideHeadingTextElement" = GuideHeadingTextElement, "guideGroupClickableElement" = GuideGroupClickableElement, "guideImageElement" = GuideImageElement, "guideButtonElement" = GuideButtonElement, "guideRadioButtonElement" = GuideRadioButtonElement, "guideCheckboxElement" = GuideCheckboxElement, "guideDropdownElement" = GuideDropdownElement
Authentication failed — the api_token header is missing, malformed, or has been revoked.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.
Rate limit exceeded for this api_token. Wait for the duration in the Retry-After header before retrying.
Extension data for customer API response
Indicates the status of the API response. A value of true signifies that the request was successfully processed, while false indicates a failure or error occurred.
A list of errors encountered during the API request. Each error object provides details about the problem, including an error code and a message explaining the issue. This field is populated when the request fails or encounters issues.
One structured error in a response's Document360.Core.Messages.Core.BaseResponse.errors array.
This is the Extension data object
A technical trace showing where the error occurred within the system. Intended for backend debugging.
A clear message explaining what caused the error. This helps quickly understand what went wrong.
A short, predefined code that identifies the type of error. Useful for logging the error or raising a support request.
Any structured metadata for the error object.
A list of warnings generated during the API request. These are non-critical issues or recommendations that might affect the request but won't stop it from processing. Each warning object provides a message to inform the user of potential problems.
One non-fatal warning attached to an otherwise-successful response.
Extension Data for customer Api warning
A plain message that describes the warning and helps understand what should be reviewed.
A short, predefined code that uniquely identifies the warning type.
Contains additional non-critical information relevant to the request or response. This field provides extra details that might assist in understanding the context of the API response but is not essential for processing.
One informational message in a response's Document360.Core.Messages.Core.BaseResponse.information array. Non-error context the SPA may surface to the user.
Extension data for customer Api response information
A plain message offering helpful context about the response, such as confirmation of fallback logic or skipped operations.