Run evaluation

runProjectEval(input: RunProjectEvalInput!, idempotencyKey: String): ProjectEvalRun

Requires project.evals.run.

Arguments

ArgumentTypeRequiredDescription
inputRunProjectEvalInput!Yes
idempotencyKeyStringNoOptional retry key (1-128 characters); overrides the Idempotency-Key header. Unkeyed root calls create a new run on each call; supply a key to retry safely.

Input fields

input

RunProjectEvalInput

FieldTypeRequired
projectReferenceString!Yes
evalIdString!Yes
sourceTargetKindStringNo
targetBranchIdIDNo
runtimeTargetKindStringNo
targetEnvironmentIdIDNo
runtimeTargetBranchIdIDNo
inputJSONNo
configJSONNo

Response

Returns ProjectEvalRun. Open the type for its fields and nested types.

FieldType
kindString!
runIdID!
evalIdID!
statusString!
targetKindString!
targetString!
sourceJSON
summaryJSON

All fields of ProjectEvalRun.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
mutation RunProjectEval($input: RunProjectEvalInput!, $idempotencyKey: String) {
  runProjectEval(input: $input, idempotencyKey: $idempotencyKey) {
    runId
    status
    createdAt
    completedAt
    error
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001",
    "evalId": "00000000-0000-4000-8000-000000000001"
  }
}