Skip to main content
POST
Run Eval

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
eval_id
string
required
Minimum string length: 1

Query Parameters

runtime_target_kind
enum<string> | null

Provide the runtime target kind.

Available options:
main_branch,
environment,
preview_branch
target_environment_id
string<uuid> | null

Provide the target environment id.

target_branch_id
string<uuid> | null

Provide the target branch id.

source_target_kind
enum<string>

Provide the source target kind.

Available options:
project,
main_branch,
environment,
preview_branch

Body

application/json
input
object
config
object

Response

Eval run

kind
enum<string>
required
Available options:
eval-run
runId
string
required
evalId
string
required
status
enum<string>
required
Available options:
pending,
running,
waiting,
completed,
failed,
cancelled
targetKind
enum<string>
required
Available options:
agent
target
string
required
summary
object | null
required
reportPath
string | null
required
metadata
object
required
createdAt
string
required
startedAt
string | null
required
completedAt
string | null
required
source
object
error
unknown