> ## Documentation Index
> Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Update eval source (legacy)

> Change fields of a structured eval with the legacy patch body. Requires project.evals.write.

**Deprecated.** Legacy eval update path and body. Use Update eval (`updateEval`) instead.



## OpenAPI

````yaml /cloud/rest/openapi.json patch /projects/{project_reference}/evals/{eval_id}/source
openapi: 3.1.0
info:
  title: Veryfront REST API reference
  version: 1.0.0
  description: |-
    ## Explore the API

    | Domain | Use it to |
    | --- | --- |
    | [Projects](#tag/projects) | Manage projects and files. |
    | [Agents](#tag/agents) | Manage agent primitives. |
    | [Orchestration](#tag/execution) | Manage conversations and runs. |
    | [Evaluations](#tag/evaluations) | Manage evaluations and results. |
    | [AI Gateway](#tag/ai-gateway) | Access models and inference. |
    | [MCP](#tag/mcp) | Discover tools and authorization. |
    | [Integrations](#tag/integrations) | Manage connections and integrations. |
    | [Knowledge](#tag/knowledge) | Manage documents and search. |
    | [Deployments](#tag/deployments) | Manage releases and deployments. |
    | [Runtime](#tag/runtime) | Manage environments and infrastructure. |
    | [Observability](#tag/observability) | Monitor activity and performance. |
    | [Identity & Access](#tag/identity-access) | Manage identity and access. |
    | [Billing & Usage](#tag/billing-usage) | Manage billing and usage. |
    | [Other](#tag/platform) | Inspect health and API metadata. |

    [OpenAPI specification (JSON)](/openapi.json)
  contact:
    name: Veryfront API Support
    url: https://veryfront.com/docs
    email: support@veryfront.com
  x-api-id: 5f1f0b8a-6b0e-4c1a-9b35-0f3a1e6d84c7
  x-audience: external-public
servers:
  - url: https://api.veryfront.com
security:
  - bearerAuth: []
  - apiKeyAuth: []
tags:
  - name: projects
    description: Manage projects and files.
  - name: agents
    description: Manage agent primitives.
  - name: execution
    description: Manage conversations and runs.
  - name: evaluations
    description: Manage evaluations and results.
  - name: ai-gateway
    description: Access models and inference.
  - name: mcp
    description: Discover tools and authorization.
  - name: integrations
    description: Manage connections and integrations.
  - name: knowledge
    description: Manage documents and search.
  - name: deployments
    description: Manage releases and deployments.
  - name: runtime
    description: Manage environments and infrastructure.
  - name: observability
    description: Monitor activity and performance.
  - name: identity-access
    description: Manage identity and access.
  - name: billing-usage
    description: Manage billing and usage.
  - name: platform
    description: Inspect health and API metadata.
  - name: projects/Projects
  - name: projects/Projects/Favorites
  - name: projects/Projects/Account Projects
  - name: projects/Projects/Projects
  - name: projects/Projects/Project Labels
  - name: projects/Projects/Project templates
  - name: projects/Files
  - name: projects/Files/Files
  - name: projects/Files/File Chunks
  - name: projects/Files/Branch File Versions
  - name: projects/Files/Branch Files
  - name: projects/Files/Environment Files
  - name: projects/Files/File Versions
  - name: projects/Files/Branch File Drafts
  - name: projects/Files/Release Files
  - name: projects/Files/Sandbox Files
  - name: projects/Files/File Search
  - name: projects/Branches
  - name: projects/Branches/Branches
  - name: projects/Branches/Branch Policies
  - name: projects/Branches/Branch Approvals
  - name: projects/Branches/Branch Status Checks
  - name: projects/Branches/Project Commits
  - name: projects/Branches/Branch Merges
  - name: projects/Uploads
  - name: projects/Uploads/Upload Folders
  - name: projects/Uploads/Upload Grants
  - name: projects/Uploads/Project Uploads
  - name: projects/Uploads/Upload Visibility
  - name: agents/Agents
  - name: agents/Agents/Agents
  - name: agents/Agents/Agent Labels
  - name: agents/Agents/Agent templates
  - name: agents/Agents/Agent Tool References
  - name: agents/Agents/Agent Avatars
  - name: agents/Agents/Agent Capabilities
  - name: agents/Agents/Agent Installation
  - name: agents/Prompts
  - name: agents/Prompts/Project prompts
  - name: agents/Tools
  - name: agents/Tools/Project tools
  - name: agents/Skills
  - name: agents/Skills/Project skills
  - name: agents/Resources
  - name: agents/Resources/Project resources
  - name: agents/Tasks
  - name: agents/Tasks/Tasks
  - name: agents/Workflows
  - name: agents/Workflows/Workflows
  - name: execution/Conversations
  - name: execution/Conversations/Conversations
  - name: execution/Conversations/Conversation messages
  - name: execution/Conversations/Conversation participants
  - name: execution/Conversations/Conversation read state
  - name: execution/Triggers
  - name: execution/Triggers/Project schedules
  - name: execution/Triggers/Webhooks
  - name: execution/Triggers/Webhook events
  - name: execution/Runs
  - name: execution/Runs/Run Input Requests
  - name: execution/Runs/Runs
  - name: execution/Runs/Runtime
  - name: execution/Runs/Child Runs
  - name: execution/Runs/Conversation Runs
  - name: execution/Runs/Project Runs
  - name: execution/Runs/Webhook Runs
  - name: execution/Runs/Run Events
  - name: execution/Runs/Run Actions
  - name: execution/Runs/Run Artifacts
  - name: execution/Executors
  - name: execution/Executors/Connected agents
  - name: execution/Executors/Agent workers
  - name: evaluations/Evaluations
  - name: evaluations/Evaluations/Evaluations
  - name: evaluations/Evaluations/Evaluation Runs
  - name: ai-gateway/Models
  - name: ai-gateway/Models/Model discovery
  - name: ai-gateway/Models/Inference Models
  - name: ai-gateway/Models/Project inference policy
  - name: ai-gateway/Models/Account inference policy
  - name: ai-gateway/Inference
  - name: ai-gateway/Inference/OpenAI Chat Completions
  - name: ai-gateway/Inference/Embeddings
  - name: ai-gateway/Inference/OpenAI Responses
  - name: ai-gateway/Inference/Proxy metadata
  - name: ai-gateway/Inference/Anthropic Messages
  - name: ai-gateway/Inference/Provider gateway
  - name: ai-gateway/Inference/Gemini inference
  - name: ai-gateway/Inference/Image generation
  - name: mcp/Tools
  - name: mcp/Tools/MCP discovery
  - name: mcp/Authorization
  - name: mcp/Authorization/Protected resource discovery
  - name: integrations/Integrations
  - name: integrations/Integrations/Integration tools
  - name: integrations/Integrations/Integration catalog
  - name: integrations/Integrations/Project integrations
  - name: integrations/Connections
  - name: integrations/Connections/Connections
  - name: integrations/Channels
  - name: integrations/Channels/Channels
  - name: integrations/Channels/Setup lookups
  - name: integrations/External storage
  - name: integrations/External storage/External Files
  - name: knowledge/Documents
  - name: knowledge/Documents/Project knowledge
  - name: knowledge/Documents/Retrieval documents
  - name: knowledge/Search
  - name: knowledge/Search/Search
  - name: knowledge/Embeddings
  - name: knowledge/Embeddings/Project embeddings
  - name: deployments/Releases
  - name: deployments/Releases/Releases
  - name: deployments/Releases/Release Versions
  - name: deployments/Releases/Release Source Manifests
  - name: deployments/Deployments
  - name: deployments/Deployments/Project deployments
  - name: deployments/Artifacts
  - name: deployments/Artifacts/Dependencies
  - name: deployments/Artifacts/Release Asset Manifests
  - name: deployments/Artifacts/Style artifacts
  - name: runtime/Environments
  - name: runtime/Environments/Environments
  - name: runtime/Environments/Environment Domains
  - name: runtime/Environments/Environment variables
  - name: runtime/Environments/Project Domains
  - name: runtime/Environments/Environment Variable Keys
  - name: runtime/Servers
  - name: runtime/Servers/Environment Servers
  - name: runtime/Servers/Project servers
  - name: runtime/Sandboxes
  - name: runtime/Sandboxes/Sandbox Lifecycle
  - name: runtime/Sandboxes/Sandbox Commands
  - name: runtime/Sandboxes/Sandbox Environment
  - name: runtime/Sandboxes/Sandbox Health
  - name: runtime/Sandboxes/Sandbox Terminal
  - name: runtime/Cache
  - name: runtime/Cache/Project Cache
  - name: runtime/Cache/User Cache
  - name: observability/Logs
  - name: observability/Logs/Log entries
  - name: observability/Traces
  - name: observability/Traces/Trace spans
  - name: observability/Traces/Project traces
  - name: observability/Traces/Trace Search
  - name: observability/Metrics
  - name: observability/Metrics/Metric series
  - name: observability/Alerts
  - name: observability/Alerts/Project alerts
  - name: observability/Error types
  - name: observability/Error types/Error types
  - name: identity-access/Users
  - name: identity-access/Users/Account users
  - name: identity-access/Users/Project users
  - name: identity-access/Users/Current user
  - name: identity-access/Accounts
  - name: identity-access/Accounts/Accounts
  - name: identity-access/Invitations
  - name: identity-access/Invitations/Invitations
  - name: identity-access/Permissions
  - name: identity-access/Permissions/Feature gates
  - name: identity-access/Permissions/Project Ownership
  - name: identity-access/API keys
  - name: identity-access/API keys/API keys
  - name: identity-access/Authentication
  - name: identity-access/Authentication/Sign-in
  - name: identity-access/Authentication/Tokens
  - name: identity-access/Authorization
  - name: identity-access/Authorization/Authorized apps
  - name: identity-access/Authorization/General OAuth
  - name: identity-access/Authorization/Consent
  - name: billing-usage/Subscriptions
  - name: billing-usage/Subscriptions/Subscriptions
  - name: billing-usage/Subscriptions/Seats
  - name: billing-usage/Billing
  - name: billing-usage/Billing/Invoices
  - name: billing-usage/Billing/Payments
  - name: billing-usage/Billing/Payment Methods
  - name: billing-usage/Billing/Billing Details
  - name: billing-usage/Billing/Account billing
  - name: billing-usage/Credits
  - name: billing-usage/Credits/Credits
  - name: billing-usage/Budgets
  - name: billing-usage/Budgets/Budgets
  - name: billing-usage/Usage
  - name: billing-usage/Usage/API key usage
  - name: billing-usage/Usage/Account usage
  - name: billing-usage/Usage/Project usage
  - name: billing-usage/Analytics
  - name: billing-usage/Analytics/Conversation Analytics
  - name: billing-usage/Analytics/Run Analytics
  - name: platform/Other
  - name: platform/Other/API metadata
paths:
  /projects/{project_reference}/evals/{eval_id}/source:
    patch:
      tags:
        - evaluations/Evaluations/Evaluations
      summary: Update eval source (legacy)
      description: >-
        Change fields of a structured eval with the legacy patch body. Requires
        project.evals.write.


        **Deprecated.** Legacy eval update path and body. Use Update eval
        (`updateEval`) instead.
      operationId: updateEvalSource
      parameters:
        - $ref: '#/components/parameters/ProjectReference'
        - schema:
            type: string
            minLength: 1
          required: true
          name: eval_id
          in: path
        - schema:
            type: string
          required: false
          name: source_target_kind
          in: query
        - schema:
            type:
              - string
              - 'null'
            format: uuid
          required: false
          name: target_branch_id
          in: query
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                kind:
                  type: string
                  enum:
                    - eval-source-patch
                id:
                  type: string
                source:
                  type: object
                  properties:
                    filePath:
                      type: string
                      description: 'Deprecated: use source_path of the eval.'
                    exportName:
                      type: string
                      description: 'Deprecated: use export_name of the eval.'
                    content:
                      type: string
                  required:
                    - filePath
                    - exportName
                fields:
                  type: object
                  properties:
                    name:
                      type: string
                      minLength: 1
                    description:
                      type: string
                    target:
                      type: string
                      minLength: 1
                    dataset:
                      type: object
                      properties:
                        kind:
                          type: string
                          enum:
                            - inline
                            - json
                            - jsonl
                            - dynamic
                        path:
                          type: string
                        examples:
                          type: array
                          items:
                            type: object
                            properties:
                              id:
                                type: string
                                minLength: 1
                              input: {}
                              reference: {}
                              metadata:
                                type: object
                                additionalProperties: {}
                            required:
                              - id
                        editable:
                          type: boolean
                        dynamic:
                          type: boolean
                      required:
                        - kind
                        - editable
                        - dynamic
                    repetitions:
                      type: integer
                      exclusiveMinimum: 0
                    tags:
                      type: array
                      items:
                        type: string
                    metadata:
                      type: object
                      additionalProperties: {}
                    metrics:
                      type: array
                      items:
                        type: object
                        properties:
                          name:
                            type: string
                            minLength: 1
                          family:
                            type: string
                            enum:
                              - answer
                              - agent
                              - ops
                              - judge
                              - knowledge
                              - check
                          severity:
                            type: string
                            enum:
                              - gate
                              - soft
                              - budget
                          threshold:
                            type: object
                            properties:
                              min:
                                type: number
                              max:
                                type: number
                          config:
                            type: object
                            additionalProperties: {}
                          editable:
                            type: boolean
                          dynamic:
                            type: boolean
                        required:
                          - name
                          - family
                          - severity
                          - editable
                          - dynamic
              required:
                - kind
                - id
                - source
                - fields
      responses:
        '200':
          description: Updated eval source document
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvalSourceDocument'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcePrimitiveErrorEnvelope'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcePrimitiveErrorEnvelope'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcePrimitiveErrorEnvelope'
        '404':
          description: Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcePrimitiveErrorEnvelope'
        '409':
          description: Conflict
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SourcePrimitiveErrorEnvelope'
      deprecated: true
components:
  parameters:
    ProjectReference:
      schema:
        $ref: '#/components/schemas/ProjectReference'
      required: true
      description: Project slug, UUID, or domain that identifies the project.
      name: project_reference
      in: path
  schemas:
    EvalSourceDocument:
      type: object
      properties:
        kind:
          type: string
          enum:
            - eval-source-document
        id:
          type: string
        name:
          type: string
        description:
          type: string
        targetKind:
          type: string
          enum:
            - agent
          description: 'Deprecated: use target_kind.'
        target:
          type: string
        source:
          type: object
          properties:
            filePath:
              type: string
              description: 'Deprecated: use source_path of the eval.'
            exportName:
              type: string
              description: 'Deprecated: use export_name of the eval.'
            content:
              type: string
          required:
            - filePath
            - exportName
        dataset:
          type: object
          properties:
            kind:
              type: string
              enum:
                - inline
                - json
                - jsonl
                - dynamic
            path:
              type: string
            examples:
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                  input: {}
                  reference: {}
                  metadata:
                    type: object
                    additionalProperties: {}
                required:
                  - id
            editable:
              type: boolean
            dynamic:
              type: boolean
          required:
            - kind
            - editable
            - dynamic
        metrics:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
              family:
                type: string
                enum:
                  - answer
                  - agent
                  - ops
                  - judge
                  - knowledge
                  - check
              severity:
                type: string
                enum:
                  - gate
                  - soft
                  - budget
              threshold:
                type: object
                properties:
                  min:
                    type: number
                  max:
                    type: number
              config:
                type: object
                additionalProperties: {}
              editable:
                type: boolean
              dynamic:
                type: boolean
            required:
              - name
              - family
              - severity
              - editable
              - dynamic
        repetitions:
          type: integer
          exclusiveMinimum: 0
        tags:
          type: array
          items:
            type: string
        metadata:
          type: object
          additionalProperties: {}
        editableFields:
          type: array
          items:
            type: string
            enum:
              - name
              - description
              - target
              - dataset
              - repetitions
              - tags
              - metadata
              - metrics
              - check
          description: 'Deprecated: use editable_fields.'
        dynamicFields:
          type: array
          items:
            type: string
            enum:
              - name
              - description
              - target
              - dataset
              - repetitions
              - tags
              - metadata
              - metrics
              - check
          description: 'Deprecated: use dynamic_fields.'
        capabilities:
          type: array
          items:
            type: string
            enum:
              - project.evals.read
              - project.evals.write
              - project.evals.run
        target_kind:
          type: string
          enum:
            - agent
          description: The same value as targetKind.
        source_path:
          type: string
          description: The same value as source.filePath.
        export_name:
          type: string
          description: The same value as source.exportName.
        editable_fields:
          type: array
          items:
            type: string
            enum:
              - name
              - description
              - target
              - dataset
              - repetitions
              - tags
              - metadata
              - metrics
              - check
          description: The same value as editableFields.
        dynamic_fields:
          type: array
          items:
            type: string
            enum:
              - name
              - description
              - target
              - dataset
              - repetitions
              - tags
              - metadata
              - metrics
              - check
          description: The same value as dynamicFields.
        edit_mode:
          type: string
          enum:
            - structured
            - source_only
          description: >-
            Editing mode of the eval. Returned with a source document, not in
            the list.
        source_only_reasons:
          type: array
          items:
            type: string
          description: >-
            Why the eval can only be edited as source. Returned with a source
            document, not in the list.
      required:
        - kind
        - id
        - name
        - targetKind
        - target
        - source
        - dataset
        - metrics
        - repetitions
        - tags
        - metadata
        - editableFields
        - dynamicFields
        - capabilities
        - target_kind
        - source_path
        - export_name
        - editable_fields
        - dynamic_fields
    SourcePrimitiveErrorEnvelope:
      type: object
      properties:
        type:
          type: string
        title:
          type: string
        status:
          type: number
        detail:
          type: string
        error:
          type: string
        message:
          type: string
        edit_mode:
          type: string
          enum:
            - structured
            - source_only
        source_only_reasons:
          type: array
          items:
            type: string
        source_path:
          type: string
    ProjectReference:
      type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT or API Key
      description: >-
        Use a JWT bearer token or a Veryfront API key in the `Authorization`
        header.
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: Alternative API key header for `vf_<prefix>_<secret>` tokens.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.