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

# Start an evaluation job

> Submits an evaluation job for a model version config.



## OpenAPI

````yaml POST /v2/autoevals
openapi: 3.1.0
info:
  title: GenAI API Spec
  description: 'Data Engine: Generative AI API Specification'
  version: 0.0.1
servers:
  - url: https://api.scale.com
security:
  - bearerAuth: []
  - basicAuth: []
paths:
  /v2/autoevals:
    post:
      summary: Start an evaluation job
      description: Submits an evaluation job for a model version config.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - libraryName
                - modelVersionConfig
              properties:
                libraryName:
                  type: string
                  description: Name of the evaluation library.
                evaluationType:
                  type: object
                  properties:
                    chatCompletion:
                      type: object
                      properties:
                        solutions:
                          type: integer
                          description: >-
                            Number of solutions to generate (default 1, max 5).
                            (Not used for frontier evaluations)
                          default: 1
                          minimum: 1
                          maximum: 5
                        shots:
                          type: integer
                          description: >-
                            Number of shots to provide (default 0, max 5). (Not
                            used for frontier evaluations)
                          default: 0
                          minimum: 0
                          maximum: 5
                        chainOfThought:
                          type: boolean
                          description: >-
                            Enable chain-of-thought reasoning (default false).
                            (Not used for frontier evaluations)
                          default: false
                modelVersionConfig:
                  type: string
                  description: ID of the Model Version Config to be evaluated.
                modelParams:
                  type: object
                  additionalProperties: true
                  description: Model params overrides.
      responses:
        '200':
          description: Auto-evaluation job successfully started.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutoEvalJob'
        '500':
          description: Internal server error.
          content:
            application/json:
              schema:
                type: object
                properties:
                  status_code:
                    type: number
                    example: 500
                  error:
                    type: string
                    example: Internal server error.
components:
  schemas:
    AutoEvalJob:
      type: object
      properties:
        jobId:
          type: string
          description: Unique identifier for the evaluation job.
        status:
          type: string
          enum:
            - Pending
            - InProgress
            - Errored
            - Completed
          description: Current job status.
        libraryName:
          type: string
          description: Name of the evaluation library.
        libraryVersion:
          type: string
          description: Version of the evaluation library.
        evaluationOptions:
          type: object
          additionalProperties: true
          description: Options used for evaluation.
        modelVersionConfig:
          type: string
          description: ID of the Model Version Config
        modelParams:
          type: object
          additionalProperties: true
          description: Model params overrides.
        createdAt:
          type: string
          format: date-time
          description: Timestamp when the job was created.
        completedAt:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the job was completed.
  securitySchemes:
    bearerAuth:
      description: >-
        Your API Key is the Bearer token. See the
        [Authentication](/get-started/authentication) section to learn how to
        access your key.
      type: http
      scheme: bearer
    basicAuth:
      description: >-
        Basic HTTP Authentication. Your API Key is your username.  Learn more
        about setting up Authentication [here](/get-started/authentication).
      type: http
      scheme: basic

````