Classify Text

POST

/v1/classify

• Production Server

Classify a single text input into one of the provided classes. Provide either inline classes or a classification_set signature.

Authorizations

• BearerAuth

Request Body ^required

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

Responses

200

Classification result

object

results

required

Array<object>

object

input

required

string

classification

required

string

extraction_needed

required

boolean

confidence

required

number

extracted

Array<object>

object

query

required

string

classification

required

string

confidence

required

number

metadata

required

object

requests_used

required

integer

source

required

string

Allowed values: cache compute

requests_remaining

required

integer

extraction_performed

boolean

sub_classifications_performed

integer

400

Invalid request

object

error

required

string

message

required

string

code

required

integer

401

Unauthorized

object

error

required

string

message

required

string

code

required

integer

402

Insufficient balance

object

error

required

string

message

required

string

code

required

integer

403

Resource limit reached

object

error

required

string

message

required

string

code

required

integer

429

Rate limited

object

error

required

string

message

required

string

code

required

integer

502

LLM processing error

object

error

required

string

message

required

string

code

required

integer

503

Service temporarily unavailable

object

error

required

string

message

required

string

code

required

integer