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

# Apply Evaluation Group

> Applies an evaluation group to a set of data, creating user evaluation metrics.



## OpenAPI

````yaml /openapi.json post /model-hub/eval-groups/apply-eval-group/
openapi: 3.0.0
info:
  title: FutureAGI Unified API
  version: 1.0.0
  description: >-
    Complete API documentation for FutureAGI platform - Simulate module
    (scenario management, agent definitions, test executions, call analytics)
    and Model Hub Evaluations API (evaluation templates, playgrounds, metrics,
    and execution tracking)
  contact:
    email: support@futureagi.com
servers:
  - url: https://api.futureagi.com
    description: Production API
security: []
tags:
  - name: Health
    description: Health check operations for monitoring server status
  - name: Authentication
    description: User authentication and token management
  - name: Scenarios
    description: Test scenario management and execution
  - name: Agent Definitions
    description: Agent definition CRUD operations
  - name: Agent Versions
    description: Agent version control and management
  - name: Simulator Agents
    description: Simulator agent operations
  - name: Run Tests
    description: Test execution management
  - name: Test Executions
    description: Test execution tracking and analytics
  - name: Call Executions
    description: Individual call execution details
  - name: Call Transcripts
    description: Transcript management and retrieval
  - name: Personas
    description: Persona management for testing
  - name: Analytics
    description: Analytics and reporting
  - name: Export Simulate
    description: Data export operations
  - name: Datasets
    description: >-
      Operations related to datasets, including creation, modification, and data
      management.
  - name: Eval Groups
    description: Evaluation group management
  - name: Eval Templates
    description: Base evaluation template operations
  - name: Custom Eval Templates
    description: Custom evaluation template CRUD operations
  - name: Eval Playground
    description: Test and run evaluations in playground environment
  - name: Eval Logs & Metrics
    description: Evaluation logs, metrics, and execution tracking
  - name: Eval Configuration
    description: Evaluation configuration and templates retrieval
  - name: API Keys
    description: API key management
  - name: Prompt Workbench
    description: Prompt template version labeling and lookup by name, version, or label
paths:
  /model-hub/eval-groups/apply-eval-group/:
    post:
      tags:
        - Eval Groups
      summary: Apply Evaluation Group
      description: >-
        Applies an evaluation group to a set of data, creating user evaluation
        metrics.
      operationId: applyEvalGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                eval_group_id:
                  type: string
                  format: uuid
                  description: The UUID of the evaluation group to apply.
                filters:
                  type: object
                  description: Filters to apply when selecting data.
                page_id:
                  type: string
                  description: >-
                    Identifier for the page or context where the group is being
                    applied.
                mapping:
                  type: object
                  description: Mapping configuration for the evaluations.
                deselected_evals:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    A list of evaluation template UUIDs to exclude from this
                    application.
      responses:
        '200':
          description: Evaluation group applied successfully.
          content:
            application/json:
              schema:
                type: object
        '400':
          description: Bad Request. The evaluation group does not exist for this user.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: >-
            Unauthorized. Authentication credentials were not provided or are
            invalid.
        '500':
          description: Internal Server Error. An unexpected error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
          SecretKeyAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key
      description: >-
        API Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access API Key
    SecretKeyAuth:
      type: apiKey
      in: header
      name: X-Secret-Key
      description: >-
        Secret Key for authentication. Click
        [here](https://app.futureagi.com/dashboard/keys) to access Secret Key

````