Skip to main content
POST
Classify Intent

Authorizations

Authorization
string
header
required

API token from your Handled dashboard

Body

application/json
message
string
required

The customer message or text to classify

Maximum string length: 2048
conversation_history
object[]

Prior turns in the conversation for context

top_k
integer
default:1

Number of top intents to return

Required range: 1 <= x <= 5
threshold
number
default:0

Minimum confidence score to include in results

Required range: 0 <= x <= 1

Response

Successful classification

request_id
string

Unique identifier for the inference request

message
string

The input message that was classified

predictions
object[]

Ranked list of intent predictions

top_intent
enum<string>

The highest-confidence intent

Available options:
track_order,
cancel_order,
return_item,
refund_request,
product_inquiry,
change_address,
payment_issue,
complaint,
compliment,
other
latency_ms
integer

Server-side inference time in milliseconds

model_version
string

Version of the model used