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

# shouldShedLoad

> Load shedding based on system load



## OpenAPI

````yaml api-reference/convex-openapi.yaml post /api/run/monitoring/bandwidthManager/shouldShedLoad
openapi: 3.0.3
info:
  title: Connvo Convex API
  version: 1.0.0
  description: >-
    HTTP interface for Connvo's Convex backend, exposing vetted query, mutation,
    and action endpoints.
servers:
  - url: https://Connvo-dev.convex.cloud
    description: Dev Convex deployment
  - url: https://Connvo-staging.convex.cloud
    description: Staging Convex deployment
  - url: https://Connvo-prod.convex.cloud
    description: Prod Convex deployment
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Identity, profile, and authentication operations for Connvo users.
  - name: Meetings
    description: Scheduling, managing, and retrieving meeting data.
  - name: Transcripts
    description: Endpoints for accessing call transcripts and transcription controls.
  - name: Insights
    description: AI-generated insights, summaries, and analytics derived from meetings.
  - name: Prompts
    description: Prompt management and AI conversation guidance.
  - name: Notes
    description: Collaborative meeting notes and follow-up documentation.
  - name: WebRTC
    description: Real-time communication, session signalling, and media utilities.
  - name: System
    description: General system endpoints such as health checks and diagnostics.
paths:
  /api/run/monitoring/bandwidthManager/shouldShedLoad:
    post:
      tags:
        - System
      summary: shouldShedLoad
      description: Load shedding based on system load
      operationId: postApiRunMonitoringBandwidthManagerShouldShedLoad
      requestBody:
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/Request_monitoring.bandwidthManager.shouldShedLoad
        required: true
      responses:
        '200':
          description: Convex executed your request and returned a result
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/Response_monitoring.bandwidthManager.shouldShedLoad
        '400':
          description: Failed operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
        '500':
          description: Convex Internal Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FailedResponse'
      security:
        - bearerAuth: []
components:
  schemas:
    Request_monitoring.bandwidthManager.shouldShedLoad:
      type: object
      required:
        - args
      properties:
        args:
          type: object
          required:
            - requestPriority
          properties:
            requestPriority:
              oneOf:
                - type: string
                  enum:
                    - critical
                - type: string
                  enum:
                    - high
                - type: string
                  enum:
                    - normal
                - type: string
                  enum:
                    - low
    Response_monitoring.bandwidthManager.shouldShedLoad:
      type: object
      required:
        - status
      properties:
        status:
          type: string
          enum:
            - success
            - error
        errorMessage:
          type: string
        errorData:
          type: object
        value:
          type: object
          required:
            - shouldShed
            - systemLoad
          properties:
            reason:
              type: string
            shouldShed:
              type: boolean
            systemLoad:
              type: object
              required:
                - activeConnections
                - cpuUsage
                - memoryUsage
                - queueDepth
              properties:
                activeConnections:
                  type: number
                cpuUsage:
                  type: number
                memoryUsage:
                  type: number
                queueDepth:
                  type: number
    FailedResponse:
      type: object
      properties: {}
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Standard user authentication token issued via WorkOS. Provide as
        `Authorization: Bearer <user-token>`.

````