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.
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.
Success
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
}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.
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.
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.
Bad Request
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": []
}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.
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.
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.