Creatio AI API
CopilotEngine class 
The Creatio.Copilot.CopilotEngine class implements the ICopilotEngine interface and is required to manage and execute AI Skills within Creatio. The class lets you interact with Creatio AI, ensuring GDPR and HIPAA compliance. The class provides Creatio powerful AI tools to streamline your workflow, enhance decision-making, achieve results and support users with their daily operations. The class located in the CrtCopilot package.
To interact with the class, call UserConnection.CopilotEngine.
To interact with the class interface, call UserConnection.ICopilotEngine.
Methods
ExecuteIntent()
Executes an AI Skill synchronously.
ExecuteIntentAsync()
Executes an AI Skill asynchronously.
GetAvailableIntents()
Retrieves available AI Skills based on the operating mode.
CopilotIntentCall class
The Creatio.Copilot.CopilotIntentCall class is used to encapsulate the data required to call a specific AI Skill using Creatio AI API. Use a class to let Creatio AI to execute pre-configured actions with results that depend on user-defined parameters.
View the template of CopilotIntentCall class usage below.
/* Create a "CopilotIntentCall" instance. */
var request = new CopilotIntentCall {
/* Code of the AI Skill to run. */
IntentName = "UsrCodeOfSomeAISkill",
/* Parameters of the AI Skill. */
Parameters = new Dictionary<string, object> {
{ "somepromptparameter1", "some parameter value" },
{ "somepromptparameter2", "some parameter value" }
}
};
Properties
IntentName string
Code of the AI Skill to run.
Parameters IDictionary<string, object>
Input parameters that are specified in the Prompt property of the AI Skill. Creatio only supports string parameter type.
CopilotIntentCallResult class
The Creatio.Copilot.CopilotIntentCallResult class provides the result of an AI Skill execution using Creatio AI API. Creatio AI API changes the status of the AI Skill execution depending on the received exception, instead of creating an exception.
Properties
Status IntentCallStatus
Status of the Creatio AI execution. Defined by the Creatio.Copilot.IntentCallStatus enumeration value. Most values of the Status property are localizable, except the FailedToExecute value that initiates an exception message in the ErrorMessage property.
Available values (Creatio.Copilot.IntentCallStatus)
ExecutedSuccessfully | The AI Skill is executed successfully. |
CantGenerateGoodResponse | The AI Skill execution failed because Creatio AI is unable to generate a result that can be displayed to the user. |
FailedToExecute | The AI Skill execution failed. |
InsufficientPermissions | The AI Skill execution failed due to insufficient user permissions. |
ResponseParsingFailed | The AI Skill execution failed due to inability to parse AI Skill output parameters. |
IntentNotFound | The AI Skill execution failed because AI Skill was not found. |
InactiveIntent | The AI Skill execution failed because Status property of the AI Skill includes "Deactivated" or "In development" value. |
WrongIntentMode | The AI Skill execution failed because Usage mode property of the AI Skill includes incorrect value. |
Content string
Content generated by Creatio AI.
ErrorMessage string
Error message of the Creatio AI execution. Returns the text of error message if error occurs during the AI Skill execution, i.e., the Status property contains a value different from ExecutedSuccessfully. Otherwise, null.
Warnings IList<string>
A warning list of the Creatio AI execution. Returns a list of warnings if the input parameters of the AI Skill are empty, they have incorrect format or there are additional input parameters that are not part of the AI Skill. Many warnings are separated by user-defined characters. For example, commas, semicolons. Otherwise, null.
IsSuccess bool
Indicates whether the AI Skill was executed successfully.
CopilotIntentStatus enum
The Creatio.Copilot.CopilotIntentStatus enumeration provides a list of AI Skill statuses. Creatio displays the status in the Status property on the AI Skill page.
Active | An active AI Skill, triggered for all users. |
InDevelopment | An AI Skill in development. Triggered only for users that have access to the "CanDevelopCopilotIntents" ( |
Deactivated | A deactivated AI Skill. Not triggered. |
crt.CopilotGetAvailableIntentsRequest request handler 
The crt.CopilotGetAvailableIntentsRequest request handler is used to check the accessibility of the AI Skill.
Properties
intentNames: string[]
An array of AI Skill codes to be retrieved. Required.
mode?: RunCopilotIntentMode
Operating mode of the AI Skill. By default, API.
Available values (RunCopilotIntentMode)
API | Creatio can use the AI Skill on a system level. |
Chat | Creatio can use the AI Skill in interactive Creatio AI conversations. |
CopilotGetAvailableIntentsCallResult interface
The CopilotGetAvailableIntentsCallResult interface provides a list of AI Skills codes that are available for use and were passed in the request.
Properties
availableIntentNames: string[]
An array of AI Skill codes that were passed in the request. Required. If you omit the value, Creatio returns a full list of available AI Skills codes.
crt.CopilotExecuteIntentRequest request handler
The crt.CopilotExecuteIntentRequest request handler is used to run a specific AI Skill using Creatio AI.
Properties
intentNames: string
The code of the AI Skill to run. Required.
parameters?: JsonData
Configuration object of AI Skill parameter values to be used when Creatio executes AI Skill.
Creatio imports the JsonData type from the @creatio-devkit/common library. The JsonData type defines a JSON data structure and contains a "key-value" collection, where "key" is the case-sensitive name of the AI Skill parameter and "value" is the value of the AI Skill parameter.
parameters: {
someParameter1: 'Some parameter value',
someParameter2: 'Some parameter value'
}
Creatio converts this collection into the following array.
"parameters": [
{"Key": "someParameter1", "Value": "Some parameter value"},
{"Key": "someParameter2", "Value": "Some parameter value"}
]
To avoid server errors during conversion, make sure that the empty parameter value is specified as null or '' instead of undefined.
CopilotIntentCallResult interface
The CopilotIntentCallResult interface provides the result of an AI Skill execution using Creatio AI API.
Properties
content: string
Content generated by Creatio AI.
status: IntentCallStatus
Status of the Creatio AI execution. Defined by the Creatio.Copilot.IntentCallStatus enumeration value. Most values of the Status property are localizable, except the FailedToExecute value that initiates an exception message in the errorMessage property.
Available values (Creatio.Copilot.IntentCallStatus)
ExecutedSuccessfully | The AI Skill is executed successfully. |
CantGenerateGoodResponse | The AI Skill execution failed because Creatio AI is unable to generate a result that can be displayed to the user. |
FailedToExecute | The AI Skill execution failed. |
InsufficientPermissions | The AI Skill execution failed due to insufficient user permissions. |
ResponseParsingFailed | The AI Skill execution failed due to inability to parse AI Skill output parameters. |
IntentNotFound | The AI Skill execution failed because AI Skill was not found. |
InactiveIntent | The AI Skill execution failed because Status property of the AI Skill includes "Deactivated" or "In development" value. |
WrongIntentMode | The AI Skill execution failed because Usage mode property of the AI Skill includes incorrect value. |
errorMessage?: string
Error message of the Creatio AI execution. Returns the text of error message if error occurs during the AI Skill execution, i.e., the status property contains a value different from ExecutedSuccessfully. Otherwise, null.
warnings?: string[]
An array of warnings that occur during the AI Skill execution. Returns a list of warnings if the input parameters of the AI Skill are empty, they have incorrect format or there are additional input parameters that are not part of the AI Skill. Many warnings are separated by user-defined characters. For example, commas, semicolons. Otherwise, null.
IsSuccess: boolean
Indicates whether the AI Skill was executed successfully.