v1

latestOpenAPI 3.0.42026-08-04342835917.6 KB
Examples

Adds a new example to an audience.

post/audience/{audienceId}/example

Path parameters

audienceIdstring required

The unique identifier of the audience.

Request body

randomCorrectProbabilitynumber double required

The probability for an answer to be correct when randomly guessing.

explanationstring nullable

An explanation for the users if they answer the example incorrectly.

contextstring nullable

An optional textual context that provides additional information to the user.

sortIndexinteger nullable

The sort index that controls the serving order of this example within the audience. When null, the next sort index is automatically calculated.

isCommonSenseboolean nullable

Whether this example should be treated as commonsense validation. When true, incorrect answers are not accepted and the example affects global score. When null, AI auto-detection will determine if the example is common sense.

visibility'Private' | 'Public'

Response

OK

recalculationIdstring nullable

The id of the audience state recalculation dispatched as a result of adding this example. Null when the example addition cannot transition any user's state (e.g. the audience already has more examples than MaxDistillingResponses + 1).