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

# Use a grader in the current project

> Adds an available definition with this project's scope, settings, and pass threshold. These settings apply to future work; adding a grader does not change earlier simulation plans. A definition can be active only once per project. The example settings are for Response latency.



## OpenAPI

````yaml openapi.json POST /v1/grader-library/{graderDefinitionId}/use
openapi: 3.1.0
info:
  title: Egma Platform API
  version: 1.0.0
  description: >-
    The customer-facing HTTP interface used by Egma's web app, CLI, and outside
    clients.
servers:
  - url: https://app.egma.ai
security: []
paths:
  /v1/grader-library/{graderDefinitionId}/use:
    post:
      tags:
        - Graders
      summary: Use a grader in the current project
      description: >-
        Adds an available definition with this project's scope, settings, and
        pass threshold. These settings apply to future work; adding a grader
        does not change earlier simulation plans. A definition can be active
        only once per project. The example settings are for Response latency.
      operationId: useGraderInProject
      parameters:
        - name: graderDefinitionId
          in: path
          required: true
          schema:
            type: string
            minLength: 1
        - name: projectId
          in: query
          required: false
          schema:
            type: string
            minLength: 1
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                scope:
                  type: object
                  properties:
                    simulations:
                      type: array
                      items:
                        oneOf:
                          - type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - all
                            required:
                              - kind
                            additionalProperties: false
                          - type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - test_suite
                              id:
                                type: string
                                minLength: 1
                            required:
                              - kind
                              - id
                            additionalProperties: false
                          - type: object
                            properties:
                              kind:
                                type: string
                                enum:
                                  - test
                              id:
                                type: string
                                minLength: 1
                            required:
                              - kind
                              - id
                            additionalProperties: false
                    production:
                      anyOf:
                        - type: object
                          properties:
                            samplePercent:
                              type: number
                              minimum: 1
                              maximum: 100
                          required:
                            - samplePercent
                          additionalProperties: false
                        - type: 'null'
                  required:
                    - simulations
                    - production
                  additionalProperties: false
                  description: >-
                    Select all simulations, particular test suites or tests,
                    and/or a production sample from 1 through 100 percent.
                    production: null disables production grading.
                settings:
                  type: object
                  additionalProperties: true
                  description: >-
                    Complete values for the definition's settingDefinitions.
                    Omit settings to save the declared defaults on first use.
                    LLM graders use llm_provider and llm_model; Response latency
                    uses maximum_response_time_ms.
                passThreshold:
                  type: number
                  minimum: 0
                  maximum: 1
                  description: >-
                    The minimum score for this grader's individual result to
                    pass.
              required:
                - scope
                - passThreshold
              additionalProperties: false
              examples:
                - scope:
                    simulations:
                      - kind: all
                    production: null
                  settings:
                    maximum_response_time_ms: 3000
                  passThreshold: 1
      responses:
        '201':
          description: The new current-project grader policy.
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                  projectId:
                    type: string
                    minLength: 1
                  graderDefinitionId:
                    type: string
                    minLength: 1
                  name:
                    type: string
                  description:
                    anyOf:
                      - type: string
                      - type: 'null'
                  owner:
                    type: string
                    enum:
                      - egma
                      - project
                  type:
                    type: string
                    enum:
                      - llm_as_judge
                      - code
                  modalities:
                    type: array
                    items:
                      type: string
                      enum:
                        - chat
                        - voice
                    minItems: 1
                    uniqueItems: true
                  scopeEditable:
                    type: boolean
                  removable:
                    type: boolean
                  scope:
                    type: object
                    properties:
                      simulations:
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - all
                              required:
                                - kind
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - test_suite
                                id:
                                  type: string
                                  minLength: 1
                              required:
                                - kind
                                - id
                              additionalProperties: false
                            - type: object
                              properties:
                                kind:
                                  type: string
                                  enum:
                                    - test
                                id:
                                  type: string
                                  minLength: 1
                              required:
                                - kind
                                - id
                              additionalProperties: false
                      production:
                        anyOf:
                          - type: object
                            properties:
                              samplePercent:
                                type: number
                                minimum: 1
                                maximum: 100
                            required:
                              - samplePercent
                            additionalProperties: false
                          - type: 'null'
                    required:
                      - simulations
                      - production
                    additionalProperties: false
                  settings:
                    type: object
                    additionalProperties: true
                  passThreshold:
                    type: number
                    minimum: 0
                    maximum: 1
                  createdAt:
                    type: string
                    format: date-time
                  updatedAt:
                    type: string
                    format: date-time
                required:
                  - id
                  - projectId
                  - graderDefinitionId
                  - name
                  - description
                  - owner
                  - type
                  - modalities
                  - scopeEditable
                  - removable
                  - scope
                  - settings
                  - passThreshold
                  - createdAt
                  - updatedAt
                additionalProperties: false
        '400':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '401':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '403':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '404':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '409':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '422':
          description: The request was refused.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
        '429':
          description: The request rate limit was reached.
          headers:
            Retry-After:
              description: Seconds to wait before trying again.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Refusal'
      security:
        - bearerAuth: []
        - sessionCookie: []
components:
  schemas:
    Refusal:
      type: object
      properties:
        error:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
      required:
        - error
        - message
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: An Egma API key.
    sessionCookie:
      type: apiKey
      in: cookie
      name: egma.session_token
      description: >-
        The browser session cookie issued by Egma. HTTPS deployments add the
        standard __Secure- prefix.

````