Skip to main content
GET
/
projects
/
{project_reference}
/
evals
List Evals
curl --request GET \
  --url https://api.veryfront.com/projects/{project_reference}/evals \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "kind": "eval-source-document",
      "id": "<string>",
      "name": "<string>",
      "targetKind": "agent",
      "target": "<string>",
      "source": {
        "filePath": "<string>",
        "exportName": "<string>",
        "content": "<string>"
      },
      "dataset": {
        "editable": true,
        "dynamic": true,
        "path": "<string>",
        "examples": [
          {
            "id": "<string>",
            "input": null,
            "reference": null,
            "metadata": {}
          }
        ]
      },
      "metrics": [
        {
          "name": "<string>",
          "editable": true,
          "dynamic": true,
          "threshold": {
            "min": 123,
            "max": 123
          },
          "config": {}
        }
      ],
      "repetitions": 1,
      "tags": [
        "<string>"
      ],
      "metadata": {},
      "editableFields": [],
      "dynamicFields": [],
      "capabilities": [],
      "description": "<string>"
    }
  ],
  "errors": [
    {
      "filePath": "<string>",
      "error": "<string>"
    }
  ]
}

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

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

Project eval source documents

data
object[]
required
errors
object[]