Skip to main content
POST
Create an evaluator

Authorizations

Authorization
string
header
required

Access token issued by WorkOS AuthKit.

Body

application/json
test_id
string<uuid>
required

Test to compile into matchers.

Example:

"7ef34f0b-0ae6-4e26-ae92-f49d239d4d7d"

twins
string[]
required

Catalog slugs of the twins whose APIs the outcomes are about.

Required array length: 1 - 10 elements
Required string length: 1 - 100
Example:
test_version
integer | null

Version to pin. When omitted, evaluator creation pins the latest test version.

Required range: x > 0
Example:

3

Response

Successful Response

id
string<uuid>
required
test_id
string<uuid>
required
test_version
integer
required
status
enum<string>
required
Available options:
pending,
running,
ready,
error
twins
string[]
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
object
string
default:evaluator
Allowed value: "evaluator"
rules
Rule · object[] | null

The frozen matchers, once compilation is ready.

provenance
EvaluatorProvenance · object | null
last_error
LastError · object | null
completed_at
string<date-time> | null