Overview

The Summit AI connector enables your AI Colleagues to integrate with your organization's Symphony SummitAI platform, facilitating automated IT service management, service catalog operations, and service request workflows.

Symphony SummitAI is an ITIL 2011 certified solution that unifies service management, asset management, and operations management in a single easy-to-use offering. The Summit AI connector allows Leena AI to automate ITSM workflows, manage service requests, browse service catalogs, and handle attachments seamlessly.

API Details

Leena AI integrates with Summit AI via REST APIs using a service-oriented architecture with a single endpoint where operations are differentiated by a ServiceName parameter within the request payload.

Documentation link: https://docs.symphonysummitai.com/display/DS/SummitAI+API+Docs

Setup

The Summit AI connector uses API Key authentication. The authentication requires API Key, Proxy ID, and Organization ID to be passed in the request body for all API calls.

Prerequisites

Before setting up the Summit AI connector, ensure you have:

Administrator access to your Symphony SummitAI application
Access to Admin > Basic > Users section in SummitAI
Ability to create API Key users in SummitAI
Access to your Leena AI workspace with connector management permissions

Get credentials

Here is how to generate an API Key in Symphony SummitAI:

Log into the SummitAI application (Ensure you're signed in as an admin)
Navigate to User Management:
1. Select Admin > Basic > Users > User List
2. The USER LIST page is displayed
Create a New API User:
1. Click ADD NEW on the ACTIONS panel
2. The NEW USER page is displayed
Configure User Details:
1. Select the Domain and specify the User Name
2. On the General tab, specify all the required details
3. On the Access tab, select the Login Type as API Key
4. The API Key of the selected Domain is picked up by the Application by default
5. Specify the API Key Expiry date
6. Select the Role Template from the list (ensure API can access required departments)
Save the User:
1. Click SUBMIT
2. Note down the generated API Key, Proxy ID, and Org ID (These credentials are required for connector configuration)

Add connection

Here is how to add a connection on Leena AI:

Log in to your Leena AI workspace
Navigate to Settings > Integrations
Search for "Summit AI" and select it from the list to add its new connector
Start configuring the connector
1. Base URL: The base URL of your SummitAI instance (e.g., https://yourcompany.symphonysummit.com)
2. Instance: The instance code for your SummitAI environment (e.g., IT)
3. Auth Type: Select "API Key" from the dropdown
4. API Key: The API Key generated from SummitAI
5. Proxy ID: The Proxy ID associated with your API user
6. Org ID: The Organization ID for your SummitAI instance
Save the Connection:
1. Click Save to store the connector configuration
2. The connector will validate the credentials and establish the connection
3. Upon successful validation, the connector status will show as connected

Actions

The following actions are supported for the Summit AI connector:

List Catalog Items

Retrieves a list of service catalog items from Summit AI. The Agent can leverage the skill (workflow), which has been designed to browse and list available service catalog items, once the user requests to view available services. Here are some common use cases:

Service Discovery: Browse all available IT services in the catalog
Category Navigation: List items within a specific category
Service Selection: Help users find the right service to request

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Name	Description
User ID	The user ID of the requester browsing the catalog
Category ID	The category ID to filter catalog items

Optional

Name	Description
Data Type	The type of data to retrieve. Options: Catalog (list catalog items), Category (list categories)

Here is a sample JSON input:

{
  "ServiceName": "SR_GetServiceCatalogDetails",
  "objCommonParameters": {
    "ServiceRequestPropertyContract": {
      "CategoryOrCatalog": "Catalog",
      "UserID": "12345",
      "Instance": "IT",
      "SearchKeyword": "",
      "EntitledService": false,
      "OrgID": "1",
      "CategoryID": "5",
      "CatalogTypeID": 0
    },
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXXXXX",
      "ProxyID": "0",
      "OrgID": "1",
      "ReturnType": "JSON"
    }
  }
}

Response

The action returns a list of catalog items, each containing:

Catalog ID
Catalog Name
Category Information
Description
Service Details

Get Catalog Form

Fetches the dynamic form schema for a specific service catalog item in Summit AI. The Agent can leverage this action to retrieve the input form required for submitting a service request. Here are some common use cases:

Dynamic Form Generation: Get the specific input fields required for a catalog item
Form Validation: Understand required fields before service request submission
Custom Fields Retrieval: Obtain catalog-specific custom field definitions

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Name	Description
Catalog ID	The unique identifier of the catalog item to retrieve form for

Here is a sample JSON input:

{
  "ServiceName": "SR_GetSelectedCatalogDetailsList",
  "objCommonParameters": {
    "SR_RequiredParameters": {
      "InstanceCode": "IT",
      "LogSRForUserMode": false,
      "DelegateeUserID": 0,
      "DelegationMode": false,
      "LogSRForUserID": 0
    },
    "ServiceRequestPropertyContract": {
      "CatalogID": "13",
      "OrgID": "1",
      "Instance": "IT"
    },
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXXXXX",
      "ProxyID": "0",
      "OrgID": "1",
      "ReturnType": "JSON"
    }
  }
}

Response

Upon successful retrieval, the action returns the catalog form details including:

Form Field Definitions
Field Types and Validation Rules
Custom Fields Configuration
Dropdown Options
Required Field Indicators

Create Service Request

Creates a new service request in Summit AI. The Agent can leverage the skill (workflow), which has been designed to submit a service request from the service catalog, once the user provides the required information. Here are some common use cases:

Software Requests: Submit requests for new software installations
Hardware Provisioning: Request new hardware or equipment
Access Requests: Submit requests for system access or permissions
Onboarding: Create new employee onboarding requests
General IT Services: Submit any catalog-based service request

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Name	Description
Catalog ID	The unique identifier of the service catalog item being requested
Logged By Email ID	The email ID of the user logging the service request
Requester Email ID	The email ID of the user for whom the service request is being made
Request Payload	JSON string containing the form field values and custom fields

Here is a sample JSON input:

{
  "ServiceName": "SR_LogServiceRequestCatalog",
  "objCommonParameters": {
    "_ProxyDetails": {
      "AuthType": "APIKEY",
      "APIKey": "XXXXXXXXXXXXXXXXX",
      "ProxyID": 0,
      "TokenID": "",
      "OrgID": "1",
      "ReturnType": "JSON"
    },
    "SR_TicketParame": {
      "Instance": "IT",
      "ServiceCatalogID": "13",
      "ServiceCatalogName": "",
      "RequesterEmailID": "[email protected]",
      "RequesterEmpID": "",
      "SRRemarks": "Service request for new laptop",
      "LoggedByEmailID": "[email protected]",
      "LoggedByEmpID": "",
      "ValidityStartDate": "2025-01-15",
      "ValidityEndDate": "2025-12-31",
      "CustomFields": [
        {
          "GroupName": "Hardware Details",
          "AttributeName": "Laptop Model",
          "AttributeValue": "Dell Latitude 5540"
        },
        {
          "GroupName": "Hardware Details",
          "AttributeName": "RAM Required",
          "AttributeValue": "16GB"
        }
      ],
      "Approvals": [
        {
          "ApproverEmailId": "[email protected]",
          "ApproverEmpId": "",
          "ApproverUserID": 0,
          "ApproverMobileNo": ""
        }
      ]
    }
  }
}

Response

Upon successful creation, the action returns the created service request details including:

Service Request ID
Service Request Number
Status
Creation Timestamp
Approval Workflow Status

Upload Service Request Attachment

Uploads an attachment to an existing service request in Summit AI. The Agent can leverage this action to attach supporting documents, screenshots, or files to a service request. Here are some common use cases:

Supporting Documents: Attach quotes, purchase orders, or approval documents
Screenshots: Upload error screenshots for troubleshooting requests
Forms: Attach signed forms or authorization documents
Evidence: Provide supporting evidence for service requests

Input Parameters

Here are the input parameters required to set up this action:

Mandatory

Name	Description
Service Request ID	The unique identifier of the service request to attach the file to
File Name	The name to give the attachment (including file extension)
File Data	The file data as either a URL to download from or a base64 encoded string of the file content

Here is a sample JSON input:

// Upload from URL

{
  "_ProxyDetails": {
    "AuthType": "APIKEY",
    "APIKey": "XXXXXXXXXXXXXXXXX",
    "ProxyID": "0",
    "OrgID": "1",
    "ReturnType": "JSON"
  },
  "eModule": "ServiceRequest",
  "TicketNo": "SR-2025-001234",
  "base64EncodedData": "",
  "AttachmentFileName": "purchase_quote.pdf"
}

// Upload from Base64

{
  "_ProxyDetails": {
    "AuthType": "APIKEY",
    "APIKey": "XXXXXXXXXXXXXXXXX",
    "ProxyID": "0",
    "OrgID": "1",
    "ReturnType": "JSON"
  },
  "eModule": "ServiceRequest",
  "TicketNo": "SR-2025-001234",
  "base64EncodedData": "JVBERi0xLjQKJeLjz9MKMyAwIG9iago8PC9GaWx0ZXIvRmxhdGVEZWNvZGUvTGVuZ3RoIDQ...",
  "AttachmentFileName": "screenshot.png"
}

Response

Upon successful upload, the action returns:

Confirmation of successful attachment
Attachment ID
Upload timestamp
File details (name, size)