/configuration/organization.{organization_numeric_id}.ai.summarySet AI summary configuration for an organization
Set the AI summary configuration for the given organization. Setting `summary_workflow` to any value other than `dont-generate` enables AI summarization at the end of a session; the generated summary is handled according to the selected workflow. Setting it to `dont-generate` (the default) disables the feature. Allowed `summary_workflow` values: * **review-generation** - Generate a summary for the agent to review. * **automatic-crm-note** - Automatically post the summary as a note to the CRM. Only for ServiceNow and SFDC customers. * **automatic-crm-resolution** - Automatically post the summary as a resolution to the CRM. Only for ServiceNow customers. * **data-collection** - Collect data for summarization without surfacing a summary. * **dont-generate** - Do not generate a summary (feature disabled). This is the default. In addition to `summary_workflow`, the fields `include_screenmeet_chat`, `enable_post_to_crm`, `enable_post_as_resolution`, `log_to_kibana`, and `retain_raw_data` may optionally be set (see the request body below). All fields are optional - any field omitted from the request is left unchanged. The summarizer definition (`activeSummarizer`) is managed through the ScreenMeet console's **AI Studio** and should not be edited via the API. > **Entitlement required:** The AI summary feature only works when the > AI+ (`aiplus`) entitlement is enabled for the organization's customer. > Attempting to enable a summary workflow without it returns a `400` > validation error.
Authorization
Parameters
Numeric Id of the organization
Request body
All fields are optional. Any field omitted from the request is left unchanged; only the fields included in the request are updated. * **summary_workflow** - The summary workflow to apply at the end of a session. Set to `review-generation` to enable AI summarization for agent review. * **include_screenmeet_chat** - Include ScreenMeet chat transcript in the summary input. * **enable_post_to_crm** - Post the summary as a note to the CRM. Only for ServiceNow and SFDC customers. * **enable_post_as_resolution** - Post the summary as a resolution to the CRM. Only for ServiceNow customers. * **log_to_kibana** - Diagnostic logging toggle for troubleshooting and diagnostics. * **retain_raw_data** - Retain raw summary data beyond the default retention policy. ```json { "summary_workflow": "review-generation" } ```
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.
summary_workflowstring
Controls the summary workflow at the end of a session. Set to a value other than `dont-generate` to enable AI summarization.
Controls the summary workflow at the end of a session. Set to a value other than `dont-generate` to enable AI summarization.
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.
{
"Enable review generation": {
"value": {
"summary_workflow": "review-generation"
}
}
}Responses
OK
messagestring
successboolean
{
"Success": {
"value": {
"message": "Configuration data saved.",
"success": true
}
}
}Validation error - for example, when a summary workflow is enabled but the AI+ (aiplus) entitlement is not enabled for the customer.
validboolean
fieldsobject
{
"Missing aiplus entitlement": {
"value": {
"valid": false,
"fields": {
"enabled": {
"valid": false,
"message": "Ai summary cannot be enabled when the Customer aiplus toggle is set to false."
}
}
}
}
}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"
}
}
}