Skip to main content
POST
/
projects
/
{project_reference}
/
evals
/
{eval_id}
/
runs
Run Eval
curl --request POST \
  --url https://api.veryfront.com/projects/{project_reference}/evals/{eval_id}/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "input": {},
  "config": {}
}
'
{
  "kind": "eval-run",
  "runId": "<string>",
  "evalId": "<string>",
  "targetKind": "agent",
  "target": "<string>",
  "summary": {
    "records": 123,
    "passed": 123,
    "failed": 123,
    "passRate": 123,
    "metrics": [
      {
        "name": "<string>",
        "passed": 123,
        "failed": 123,
        "skipped": 123,
        "passRate": 123
      }
    ],
    "skippedResults": 123,
    "duration": {
      "totalMs": 123,
      "minMs": 123,
      "maxMs": 123,
      "meanMs": 123,
      "p50Ms": 123,
      "p95Ms": 123
    },
    "usage": {
      "inputTokens": 123,
      "outputTokens": 123,
      "totalTokens": 123,
      "costUsd": 123
    },
    "gateFailures": [
      {
        "recordId": "<string>",
        "exampleId": "<string>",
        "repetition": 123,
        "name": "<string>",
        "explanation": "<string>",
        "evidence": {}
      }
    ],
    "failedExamples": [
      {
        "exampleId": "<string>",
        "records": 123,
        "passed": 123,
        "failed": 123,
        "passRate": 123,
        "flaky": true
      }
    ],
    "flakes": {
      "examples": 123,
      "stablePassed": 123,
      "stableFailed": 123,
      "flaky": 123
    }
  },
  "reportPath": "<string>",
  "metadata": {},
  "createdAt": "<string>",
  "startedAt": "<string>",
  "completedAt": "<string>",
  "source": {
    "filePath": "<string>",
    "exportName": "<string>",
    "content": "<string>"
  },
  "error": null
}

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
required
reportPath
string | null
required
metadata
object
required
createdAt
string
required
startedAt
string | null
required
completedAt
string | null
required
source
object
error
unknown