Skip to main content
POST
Evaluate labels

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
contentData
Content Data · object
required

A single piece of content to be processed by the Clavata.ai API.

threshold
number<double>

The threshold to use for truthiness. If not set a default value will be used.

labelVersionIds
string[]

IDs of the published label versions to evaluate against. Maximum 25 per request.

labelEvalOptions
object

LabelEvalOptions are options that can be set per-label to control evaluation behavior. Field numbers/types intentionally mirror PolicyEvalOptions for parity.

globalContext
string

Optional global context override for this evaluation call.

responseKind
enum<string>

Aggregation over the evaluated label versions. Omit for independent scores.

Available options:
score,
choice,
ordinal,
priority
abstain
boolean

Whether choice and ordinal abstain when no label evaluation has outcome TRUE. Defaults to true; set false to force selection.

Response

A successful response.

contentHash
string

The hash of the content that was evaluated.

results
object[]

Ordered results, one per requested label_version_ids entry. These retain the independent evaluations for every response kind.

choice
object
ordinal
object
priority
object
aggregateError
object