API reference
AI and automations
AI automations, evaluations with test cases and runs, and conversation summaries.
Server https://api.kustomerapp.com/v1 · 19 operations
This category describes endpoints related to Kustomer AI and Automations.
AI and Automations provide intelligent capabilities for automating customer interactions, generating responses, and analyzing conversations in Kustomer. The evaluations endpoints allow you to test and validate your AI automations with test cases and runs.
Note: The AI Agents feature must be enabled in your subscription to use these endpoints. Requests return 403 Forbidden when the feature is disabled.
To learn more, see the Kustomer Help Center.
Automations
An AI automation is an AI agent built in Kustomer, such as one that answers customers in chat or one that helps your team with their work. The API lists them so you can find an agent's ID, mainly to test it with evaluations; building and editing agents happens in Kustomer.
Evaluations
An evaluation is a test suite for one AI agent. It holds test cases, each a customer message plus a description of a good answer; running the evaluation sends every case to the agent, has an AI judge mark each answer pass or fail, and gives the agent a score from 0 to 100.
/v1/ai/automations/{automationId}/evaluationspostCreate an evaluation/v1/ai/evaluationsgetGet evaluation by ID/v1/ai/evaluations/{evaluationId}putUpdate an evaluation/v1/ai/evaluations/{evaluationId}DELDelete an evaluation/v1/ai/evaluations/{evaluationId}postRun an evaluation/v1/ai/evaluations/{evaluationId}/runEvaluation Test Cases
An evaluation is a test suite for one AI agent. It holds test cases, each a customer message plus a description of a good answer; running the evaluation sends every case to the agent, has an AI judge mark each answer pass or fail, and gives the agent a score from 0 to 100.
/v1/ai/evaluation-testcasespostCreate an evaluation test case/v1/ai/evaluation-testcasesgetGet evaluation test case by ID/v1/ai/evaluation-testcases/{testCaseId}putUpdate an evaluation test case/v1/ai/evaluation-testcases/{testCaseId}DELDelete an evaluation test case/v1/ai/evaluation-testcases/{testCaseId}Evaluation Runs
An evaluation is a test suite for one AI agent. It holds test cases, each a customer message plus a description of a good answer; running the evaluation sends every case to the agent, has an AI judge mark each answer pass or fail, and gives the agent a score from 0 to 100.
Evaluation Test Case Results
An evaluation is a test suite for one AI agent. It holds test cases, each a customer message plus a description of a good answer; running the evaluation sends every case to the agent, has an AI judge mark each answer pass or fail, and gives the agent a score from 0 to 100.
Summaries
An AI summary is a short, AI-written overview of a conversation, a customer or a custom object, which Kustomer generates and keeps up to date so agents can catch up without reading the whole history. The API reads these summaries, optionally translated.