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

# Create evaluations assistant

> Requires scopes: eval:write



## OpenAPI

````yaml /api-reference/openapi.json post /api/evaluations/{id}/playground/assistant
openapi: 3.1.0
info:
  title: EvalGate API
  version: 3.7.6
  description: EvalGate API. See docs/api-contract.md for stability commitments.
servers:
  - url: https://evalgate.com
    description: Production
  - url: http://localhost:3000
    description: Local
security: []
paths:
  /api/evaluations/{id}/playground/assistant:
    post:
      tags:
        - evaluations
      summary: Create evaluations assistant
      description: 'Requires scopes: eval:write'
      operationId: post_evaluations_id_playground_assistant
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: integer
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: >-
                #/components/schemas/PostApiEvaluationsIdPlaygroundAssistantRequest
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/PostApiEvaluationsIdPlaygroundAssistantResponse200ApplicationJson
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '409':
          $ref: '#/components/responses/Conflict'
        '429':
          $ref: '#/components/responses/RateLimited'
        '500':
          $ref: '#/components/responses/InternalError'
      security:
        - bearerAuth:
            - eval:write
components:
  schemas:
    PostApiEvaluationsIdPlaygroundAssistantRequest:
      type: object
      properties:
        command:
          type: string
        context:
          type: object
          properties:
            mode:
              oneOf:
                - type: string
                  enum:
                    - scorer
                - type: string
                  enum:
                    - trace
                - type: string
                  enum:
                    - grid
                - type: string
                  enum:
                    - compare
            variantId:
              type: number
            testCaseId:
              type: number
          additionalProperties: false
      additionalProperties: false
      required:
        - command
    PostApiEvaluationsIdPlaygroundAssistantResponse200ApplicationJson:
      type: object
      properties:
        proposal:
          oneOf:
            - type: 'null'
            - type: object
              properties:
                id:
                  type: number
                status:
                  type: string
                payload:
                  type: object
                  properties:
                    type:
                      oneOf:
                        - type: string
                          enum:
                            - scorer
                        - type: string
                          enum:
                            - dataset_rows
                        - type: string
                          enum:
                            - prompt_change
                        - type: string
                          enum:
                            - variant_change
                        - type: string
                          enum:
                            - calibration_examples
                        - type: string
                          enum:
                            - candidate_cases
                        - type: string
                          enum:
                            - manifest_change
                    summary:
                      type: string
                    before:
                      $ref: '#/components/schemas/JsonValue'
                    after:
                      $ref: '#/components/schemas/JsonValue'
                    rationale:
                      type: string
                    evidence:
                      type: array
                      items:
                        type: object
                        properties:
                          type:
                            type: string
                          id:
                            oneOf:
                              - type: string
                              - type: number
                        additionalProperties: false
                        required:
                          - type
                          - id
                    estimatedCostUsd:
                      oneOf:
                        - type: 'null'
                        - type: string
                    warnings:
                      type: array
                      items:
                        type: string
                  additionalProperties: false
                  required:
                    - type
                    - summary
                    - after
                    - rationale
                createdAt:
                  type: string
                updatedAt:
                  type: string
              additionalProperties: false
              required:
                - id
                - status
                - payload
                - createdAt
                - updatedAt
        payload:
          type: object
          properties:
            type:
              oneOf:
                - type: string
                  enum:
                    - scorer
                - type: string
                  enum:
                    - dataset_rows
                - type: string
                  enum:
                    - prompt_change
                - type: string
                  enum:
                    - variant_change
                - type: string
                  enum:
                    - calibration_examples
                - type: string
                  enum:
                    - candidate_cases
                - type: string
                  enum:
                    - manifest_change
            summary:
              type: string
            before:
              $ref: '#/components/schemas/JsonValue'
            after:
              $ref: '#/components/schemas/JsonValue'
            rationale:
              type: string
            evidence:
              type: array
              items:
                type: object
                properties:
                  type:
                    type: string
                  id:
                    oneOf:
                      - type: string
                      - type: number
                additionalProperties: false
                required:
                  - type
                  - id
            estimatedCostUsd:
              oneOf:
                - type: 'null'
                - type: string
            warnings:
              type: array
              items:
                type: string
          additionalProperties: false
          required:
            - type
            - summary
            - after
            - rationale
      additionalProperties: false
      required:
        - proposal
        - payload
    JsonValue:
      oneOf:
        - type: 'null'
        - type: boolean
        - type: number
        - type: string
        - type: array
          items:
            $ref: '#/components/schemas/JsonValue'
        - type: object
          additionalProperties:
            $ref: '#/components/schemas/JsonValue'
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - UNAUTHORIZED
                - FORBIDDEN
                - NOT_FOUND
                - VALIDATION_ERROR
                - RATE_LIMITED
                - CONFLICT
                - INTERNAL_ERROR
                - SERVICE_UNAVAILABLE
                - QUOTA_EXCEEDED
                - NO_ORG_MEMBERSHIP
                - CROSS_ORG_REFERENCE
                - INCOMPLETE
                - MALFORMED
            message:
              type: string
            details: {}
            requestId:
              type: string
              format: uuid
          required:
            - code
            - message
      required:
        - error
  responses:
    ValidationError:
      description: Validation error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    Conflict:
      description: Conflict
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    RateLimited:
      description: Rate limit exceeded
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ApiError'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key or Session Token

````