Tagging API Documentation

Introduction

IrisAgent's Automatic Tagging Engine can be used an API to get AI-powered tags corresponding to any conversation. It uses pre-built AI models to determine the right tag(s).

API Guide

Below is a curl command to call our IrisGPT API:

curl -X POST --location "https://frontend-api-server-v2.api.irisagent.com/v1/tag" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer Replace_me_business_id" \
    -H "X-Language-Iso-Code: en" \
    -d '{
          "conversationId": "12345",
          "message": "Application will not access Flight Log
When clicking on "Flight Log" the application keeps producing an ERROR message and will not allow access or Flight Log updating. Please help to fix this ASAP"
        }'
          

The API inputs are as follows,

Field	Description
conversationId	[Required] Unique ticket or chat id
message	[Required] Message from the customer that needs to be auto-tagged
Replace_me_business_id	[Required] This is the API key provided by the IrisAgent team
X-Language-Iso-Code	[Optional] This optional header allows you to specify the desired language for IrisGPT's responses. If not provided, automatic language detection will be used

A sample output of the API when matching tags are found:

{
  "tags": [
    "Application Error",
    "Flight Log",
    "Resolved"
  ]
}

A sample output of the API when no matching tags are found:

{
  "tags": []
}