Combined Evaluation
Performs multiple evaluations in parallel on a single comment. This endpoint can run any combination of comment scoring, spam detection, and relevance checking in a single call, potentially saving time and reducing latency compared to making separate API calls.
To control which evaluations to run, use the feature flags in the request body (run_comment_score, run_spam_check, run_relevance_check). At least one feature flag must be set to true.
The response contains separate sections for each requested evaluation, with the same structure as their individual endpoint responses.
| Header Parameters |
|---|
X-User-Email email — REQUIREDAccount email address, for authentication |
X-API-Key string — REQUIREDAPI key owned by the user (email), for authentication |
| Request Body — REQUIRED JSON format strongly recommended: This endpoint handles complex parameter types (arrays and booleans) which are more reliably processed when sent as JSON. A form-urlencoded format should work for simple cases, but arrays and booleans can be problematic when using form encoding. The banned_topics array in form-urlencoded requires special syntax like `banned_topics[]=topic1&banned_topics[]=topic2` (URL-encoded array notation), which can be different across HTTP libraries. Boolean values need to be represented as strings in form format (`'true'/'false'`). We recommend using JSON. |
|---|
article_context_id uuidUUID that identifies the article context. Required for comment scoring and relevance checking. |
comment string — REQUIREDThe comment text to evaluate. |
reply_to_comment stringOptional context for comment scoring: the comment to which this one is replying. |
banned_topics string[]Optional list of banned topics to check against for relevance checking. |
run_comment_score booleanWhether to perform comment scoring evaluation. |
run_spam_check booleanWhether to perform spam detection. |
run_relevance_check booleanWhether to perform relevance checking. |
run_dogwhistle_check booleanWhether to perform dogwhistle detection. |
sensitive_topics string[]Optional list of sensitive topics to watch for during dogwhistle detection. |
dogwhistle_examples string[]Optional list of specific dogwhistle examples to look for during detection. |
| Responses | |||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
200Successful response - returns JSON with results for each requested evaluation.
| |||||||||||||||||||||||||||||||||||||||||||
400Bad Request - Missing or invalid parameters, or no feature flags enabled. To diagnose this, check the request body and ensure at least one of the feature flags is set to true, and check the documentation for the individual call that matches it to verify you are sending the required parameters. For example, the article_context_id is required for comment scoring and relevance checking but is marked optional here because not all of the features this runs in parallel require it. | |||||||||||||||||||||||||||||||||||||||||||
401Unauthorized - Missing or incorrect authentication. |