Sign in

v1

latestOpenAPI 3.0.12026-07-226992320.0 KB
QA Rules

Get QA Rule

Retrieves the full details of a single QA rule by qaRuleId. Returns the rule configuration including its evaluation criteria, expected value, and agents it will be applied to.

get/v1/qa-rules/{qaRuleId}

Path parameters

qaRuleIdstring required

The unique identifier of the QA rule to retrieve.

Response

OK

qaRuleIdstring

The unique identifier of the QA rule.

workspaceIdstring

The unique identifier of the workspace this QA rule belongs to.

ruleNamestring

The name of the QA rule, used to identify it in rule lists and evaluation reports.

ruleDescriptionstring

A brief explanation of what this QA rule evaluates and its intended purpose.

evaluationCriteriastring

The specific criteria or rubric used to evaluate agent responses against this rule.

expectedValueboolean

The expected evaluation result that determines whether the QA rule is satisfied. When the evaluation criteria returns a result matching this expected value, the interaction is marked as a Success; otherwise it is marked as a Fail.

Example response

{
  "qaRuleId": "rule_YYdKgw1masomMfe8",
  "workspaceId": "org_V6eZ2zg8ziDx5pft",
  "ruleName": "Tone & Professionalism Check",
  "ruleDescription": "Ensures agents maintain a professional and empathetic tone throughout the conversation.",
  "agents": [
    {
      "name": "New AI Agent",
      "agentId": "agent_D5D0p7TUs66TTAEAx",
      "status": "Live"
    }
  ],
  "evaluationCriteria": "Evaluate whether agent greeted the customer by name, avoided interrupting, and closed with a resolution summary.",
  "expectedValue": true
}