/configuration/organization.{organization_numeric_id}.ai.summaryGet AI summary configuration for an organization
Retrieve the AI summary configuration currently set for the given organization. The AI summary feature automatically generates a summary of a Remote Support Session when it ends. Whether (and how) a summary is generated is controlled by the `summary_workflow` field (see the POST operation). Most fields returned here are managed for you through the ScreenMeet console's **AI Studio** and should not be edited directly via the API. Only `summary_workflow` is intended to be toggled through this endpoint. > **Entitlement required:** The AI summary feature only works when the > AI+ (`aiplus`) entitlement is enabled for the organization's customer.
Authorization
Parameters
Numeric Id of the organization
Responses
OK
log_to_kibanaboolean
Diagnostic logging toggle. Will allow ScreenMeet to log summary data for troubleshooting and diagnostics.
Diagnostic logging toggle. Will allow ScreenMeet to log summary data for troubleshooting and diagnostics.
retain_raw_databoolean
Will retain raw summary data on ScreenMeet's cloud storage beyond default retention policy, used for troubleshooting and diagnostics.
Will retain raw summary data on ScreenMeet's cloud storage beyond default retention policy, used for troubleshooting and diagnostics.
activeSummarizerobject
[Managed via AI Studio - do not edit] Full summarizer definition (LLM, generator, and prompt configuration). Do not edit JSON manually.
[Managed via AI Studio - do not edit] Full summarizer definition (LLM, generator, and prompt configuration). Do not edit JSON manually.
summary_workflowstring
Controls the summary workflow at the end of a session. See the POST operation for the list of allowed values.
Controls the summary workflow at the end of a session. See the POST operation for the list of allowed values.
enable_post_to_crmboolean
Post the summary as a note to the CRM. Only for ServiceNow and SFDC customers.
Post the summary as a note to the CRM. Only for ServiceNow and SFDC customers.
include_screenmeet_chatboolean
Include ScreenMeet chat transcript in the summary input.
Include ScreenMeet chat transcript in the summary input.
enable_post_as_resolutionboolean
Post the summary as a resolution to the CRM. Only for ServiceNow Customers.
Post the summary as a resolution to the CRM. Only for ServiceNow Customers.
Authorization Problem - either the JWT is malformed or the signature is bad, or permission is denied
codenumber
refcodenumber
descriptionstring
X-Request-Idstring
{
"PermissionDenied": {
"value": {
"code": 403,
"refcode": 200403,
"description": "Authorization token is invalid: Error request id: 1-62ed207a-24baa293558168e06b8402c3 [8/5/2022, 6:51:54 AM PST]",
"X-Request-Id": "1-62ed207a-24baa293558168e06b8402c3"
}
},
"MalformedJWTOrBadSignature": {
"value": {
"code": 403,
"refcode": 200403,
"description": "Authorization token is invalid: JsonWebTokenError request id: 1-62ed1a55-0265e424598b4f1b580bd784 [8/5/2022, 6:25:41 AM PST]",
"X-Request-Id": "1-62ed1a55-0265e424598b4f1b580bd784"
}
}
}