Skip to main content
GET
Get Eval Source

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

Response

Eval source document

kind
enum<string>
required
Available options:
eval-source-document
id
string
required
name
string
required
targetKind
enum<string>
required
Available options:
agent
target
string
required
source
object
required
dataset
object
required
metrics
object[]
required
repetitions
integer
required
Required range: x > 0
tags
string[]
required
metadata
object
required
editableFields
enum<string>[]
required
Available options:
name,
description,
target,
dataset,
repetitions,
tags,
metadata,
metrics,
check
dynamicFields
enum<string>[]
required
Available options:
name,
description,
target,
dataset,
repetitions,
tags,
metadata,
metrics,
check
capabilities
enum<string>[]
required
Available options:
project.evals.read,
project.evals.write,
project.evals.run
description
string