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

# Update evaluation configuration

> Updates the evaluation configuration for a scope. Changes to the schedule cadence are synced automatically.

**Requires:** `scopes:write`



## OpenAPI

````yaml https://api.getmodus.com/openapi.json put /api/v1/scopes/{id}/evaluations/config
openapi: 3.0.3
info:
  title: Modus Public API
  version: 1.0.0
servers: []
security:
  - bearerAuth: []
tags:
  - name: Scopes
    description: Create, configure, deploy, and manage scopes.
  - name: Scopes · Conversations
    description: Read scope conversation threads.
  - name: Scopes · Supervision
    description: Scope supervision sub-resource.
  - name: Scopes · Memories
    description: Long-term memory stored per scope.
  - name: Scopes · Chat
    description: Chat with a published scope.
  - name: Scopes · Context
    description: Compose a scope’s context without an LLM call.
  - name: Modus · Chat
    description: Chat with Modus — your org-wide assistant.
  - name: Modus · Conversations
    description: Read Modus and cross-scope conversation threads.
  - name: Modus · Context
    description: Compose full-environment context without an LLM call.
  - name: Workflows
    description: Create, configure, deploy, and manage workflows.
  - name: Workflows · Runs
    description: Inspect workflow run history.
  - name: Workflows · Interfaces
    description: Slack / MCP / Teams interface management.
  - name: Connections
    description: Read connected integrations.
  - name: Tools
    description: Catalog of tools/integrations a scope can select in its toolset.
  - name: Suggestions
    description: Approved suggested questions and first-party suggestion usage events.
  - name: Context
    description: Create and manage organization context items.
  - name: Usage
    description: Organization LLM usage reporting.
  - name: Users
    description: Organization and membership management.
  - name: Runs · Streaming
    description: 'Run lifecycle: stream, poll, resume, interrupt, and cancel executions.'
  - name: Scopes · Runs
    description: Run a published or draft scope.
  - name: Modus · Runs
    description: Run the Modus home agent.
paths:
  /api/v1/scopes/{id}/evaluations/config:
    put:
      tags:
        - Scopes
      summary: Update evaluation configuration
      description: >-
        Updates the evaluation configuration for a scope. Changes to the
        schedule cadence are synced automatically.


        **Requires:** `scopes:write`
      operationId: EvaluationsController_updateConfig
      parameters:
        - name: id
          required: true
          in: path
          description: Scope ID
          schema:
            example: 42
            type: number
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateEvaluationConfigDto'
            examples:
              weeklySchedule:
                value:
                  enabled: true
                  judgeModel: openai/gpt-4o
                  cadence:
                    frequency: weekly
                    timeOfDay: '09:00'
                    timezone: America/New_York
                    weekdays:
                      - TUESDAY
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EvaluationConfigDto'
        '400':
          description: >-
            Malformed request — invalid query parameters or request body (`code:
            BAD_REQUEST`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
              example:
                error:
                  code: BAD_REQUEST
                  status: INVALID_ARGUMENT
                  message: Invalid value for query parameter `pageSize`.
                  requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
        '401':
          description: 'Missing, invalid, or expired access token (`code: UNAUTHORIZED`).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
              example:
                error:
                  code: UNAUTHORIZED
                  status: UNAUTHENTICATED
                  message: Missing or invalid access token.
                  requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
        '403':
          description: >-
            Authenticated, but the token lacks a required scope (`code:
            FORBIDDEN`). The missing scopes are listed in `info`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
              example:
                error:
                  code: FORBIDDEN
                  status: PERMISSION_DENIED
                  message: Missing required scope(s) for this operation.
                  requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
                  info:
                    missing:
                      - <required-scope>
        '404':
          description: >-
            The resource does not exist, or you do not have access to it (`code:
            NOT_FOUND`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
              example:
                error:
                  code: NOT_FOUND
                  status: NOT_FOUND
                  message: Resource not found.
                  requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
        '409':
          description: >-
            The request conflicts with the current state of the resource, e.g. a
            duplicate (`code: CONFLICT`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
              example:
                error:
                  code: CONFLICT
                  status: ALREADY_EXISTS
                  message: A resource with that identifier already exists.
                  requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
        '422':
          description: >-
            The request was well-formed but failed a business rule (`code:
            VALIDATION`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
              example:
                error:
                  code: VALIDATION
                  status: INVALID_ARGUMENT
                  message: Updates that would revoke your own access are not allowed.
                  requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
        '500':
          description: 'An unexpected server error occurred (`code: INTERNAL_ERROR`).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponseDto'
              example:
                error:
                  code: INTERNAL_ERROR
                  status: INTERNAL
                  message: An unexpected error occurred.
                  requestId: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
      security:
        - bearerAuth: []
      servers:
        - url: https://api.getmodus.com
components:
  schemas:
    UpdateEvaluationConfigDto:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether scheduled evaluations are enabled
        cadence:
          description: Schedule cadence configuration
          allOf:
            - $ref: '#/components/schemas/EvaluationCadenceDto'
        judgeModel:
          type: string
          nullable: true
          description: Model ID for the judge LLM
        judgeGuidance:
          type: string
          nullable: true
          description: Custom guidance for the judge LLM
        notifications:
          description: Regression notification settings
          allOf:
            - $ref: '#/components/schemas/EvaluationNotificationsDto'
    EvaluationConfigDto:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether scheduled evaluations are enabled
        cadence:
          description: Schedule cadence configuration
          allOf:
            - $ref: '#/components/schemas/EvaluationCadenceDto'
        judgeModel:
          type: string
          nullable: true
          description: Model ID for the judge LLM
          example: openai/gpt-4o
        judgeGuidance:
          type: string
          nullable: true
          description: Custom guidance for the judge LLM
        notifications:
          description: Regression notification settings
          allOf:
            - $ref: '#/components/schemas/EvaluationNotificationsDto'
      required:
        - enabled
        - notifications
    ErrorResponseDto:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorEnvelopeDto'
      required:
        - error
    EvaluationCadenceDto:
      type: object
      properties:
        frequency:
          description: Schedule frequency
          allOf:
            - $ref: '#/components/schemas/EvaluationCadenceFrequency'
        timeOfDay:
          type: string
          description: Time of day in HH:MM format
          example: '09:00'
        timezone:
          type: string
          description: IANA timezone
          example: America/New_York
        weekdays:
          description: Days of week for weekly frequency
          example:
            - MONDAY
            - WEDNESDAY
          type: array
          items:
            type: string
        dayOfMonth:
          type: number
          description: Day of month for monthly frequency
          minimum: 1
          maximum: 31
        cronExpression:
          type: string
          description: Cron expression for custom frequency
          example: 0 9 * * 1-5
    EvaluationNotificationsDto:
      type: object
      properties:
        recipients:
          description: Notification recipients
          type: array
          items:
            $ref: '#/components/schemas/EvaluationRecipientDto'
        channels:
          description: Notification channels
          allOf:
            - $ref: '#/components/schemas/EvaluationChannelsDto'
      required:
        - recipients
        - channels
    ErrorEnvelopeDto:
      type: object
      properties:
        code:
          description: Modus-specific machine code.
          allOf:
            - $ref: '#/components/schemas/ApiErrorCode'
        status:
          description: Canonical status string for the error.
          allOf:
            - $ref: '#/components/schemas/ApiErrorStatus'
        message:
          type: string
          example: Skill was not found or you lack permission.
        requestId:
          type: string
          example: req_01HQ7K8ABCDEFGHIJKLMNOPQRS
        info:
          type: object
          description: >-
            Optional domain-specific context. Shape varies per endpoint — see
            the operation's error response examples.
          additionalProperties: true
          example:
            skillId: sk_abc123
      required:
        - code
        - status
        - message
        - requestId
    EvaluationCadenceFrequency:
      type: string
      enum:
        - daily
        - weekly
        - monthly
        - custom
      description: Schedule frequency
    EvaluationRecipientDto:
      type: object
      properties:
        clerkUserId:
          type: string
          description: Clerk user ID
        email:
          type: string
          description: Email address
        name:
          type: object
          description: Display name
      required:
        - clerkUserId
        - email
    EvaluationChannelsDto:
      type: object
      properties:
        email:
          type: boolean
          description: Enable email notifications
        slack:
          description: Slack notification configuration
          allOf:
            - $ref: '#/components/schemas/EvaluationSlackChannelDto'
      required:
        - email
    ApiErrorCode:
      type: string
      enum:
        - VALIDATION
        - BAD_REQUEST
        - UNAUTHORIZED
        - FORBIDDEN
        - NOT_FOUND
        - CONFLICT
        - RATE_LIMITED
        - INTERNAL_ERROR
      description: Modus-specific machine code.
    ApiErrorStatus:
      type: string
      enum:
        - INVALID_ARGUMENT
        - UNAUTHENTICATED
        - PERMISSION_DENIED
        - NOT_FOUND
        - ALREADY_EXISTS
        - RESOURCE_EXHAUSTED
        - INTERNAL
      description: Canonical status string for the error.
    EvaluationSlackChannelDto:
      type: object
      properties:
        nangoConnectionId:
          type: string
          description: Nango connection ID for Slack
        slackUserIdByRecipient:
          type: object
          description: Mapping of Clerk user ID to Slack user ID
      required:
        - nangoConnectionId
        - slackUserIdByRecipient
  securitySchemes:
    bearerAuth:
      scheme: bearer
      bearerFormat: Modus PAT (modus_<orgUuid>_<prefix>_<secret>) or OAuth 2.1 access token
      type: http
      description: >-
        A Modus personal access token (`modus_<orgUuid>_<prefix>_<secret>`) or
        an OAuth 2.1 access token, sent as `Authorization: Bearer <token>`.

````