Skip to content

Classify with Natural Language Response

POST
/v1/classify-respond

Classify text and generate a conversational response. Ideal for chat interfaces. Costs 2 requests for single-intent, 4 requests for multi-intent with extraction.

object
data
required
string
<= 4096 characters
classes

Inline class definitions (provide either classes or classification_set)

Array<object>
>= 1 items
object
label
required
string
description
string
classification_set

Classification set signature registered to the app (provide either classes or classification_set)

string
context

Optional context to guide classification

string

Classification with natural language response

object
response
required

Natural language response acknowledging the classification

string
classifications
required
Array<object>
object
label
required
string
confidence
required
number format: float
metadata
required
object
requests_used
required
integer
requests_remaining
required
integer
source
required
string
Allowed values: cache compute
extraction_performed
boolean
sub_classifications_performed
integer

Invalid request

object
error
required
string
message
required
string
code
required
integer

Unauthorized

object
error
required
string
message
required
string
code
required
integer

Insufficient balance

object
error
required
string
message
required
string
code
required
integer

Resource limit reached

object
error
required
string
message
required
string
code
required
integer

Rate limited

object
error
required
string
message
required
string
code
required
integer

LLM processing error

object
error
required
string
message
required
string
code
required
integer

Service temporarily unavailable

object
error
required
string
message
required
string
code
required
integer