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

# Get experiment

> Fetch one experiment batch with its run summaries and evaluator results grouped by run id.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/automations/{id}/experiments/{experimentId}
openapi: 3.1.0
info:
  title: Eigenpal API
  version: 1.0.0
  description: >-
    Public REST API for inspecting automations, starting and monitoring runs,
    managing files, collecting human reviews, and running evaluations.
  contact:
    name: Eigenpal
    url: https://eigenpal.com
  license:
    name: Apache-2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
  - url: https://api.eigenpal.com
    description: Production (canonical API hostname)
security:
  - bearerAuth: []
tags:
  - name: Metadata
    description: Authenticate and inspect the current API context.
  - name: Automations
    description: >-
      Inspect runnable workflow and agent automations, their versions, triggers,
      and source sync state.
  - name: Runs
    description: >-
      Start, monitor, retry, review, and debug automation runs, including
      artifacts.
  - name: Reviews
    description: >-
      Record human review verdicts, manage corrected outputs, and monitor review
      health.
  - name: Files
    description: Upload reusable files for later run or dataset use.
  - name: Evaluation
    description: >-
      Manage datasets, examples, evaluators, experiment batches, evaluator
      scores, and run promotion workflows.
paths:
  /v1/automations/{id}/experiments/{experimentId}:
    get:
      tags:
        - Evaluation
      summary: Get experiment
      description: >-
        Fetch one experiment batch with its run summaries and evaluator results
        grouped by run id.
      operationId: automations.experiments.get
      parameters:
        - in: path
          name: id
          schema:
            type: string
            description: Automation id or typed alias.
          required: true
          description: Automation id or typed alias.
        - in: path
          name: experimentId
          schema:
            type: string
            description: Experiment batch id.
          required: true
          description: Experiment batch id.
      responses:
        '200':
          description: Experiment detail with runs and results.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExperimentDetail'
        '400':
          description: Validation error. Request shape did not match the spec.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '401':
          description: Missing or invalid API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '403':
          description: API key lacks required scope
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '404':
          description: Resource not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '413':
          description: Payload too large. Upload exceeded the per-request size cap.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '429':
          description: Rate limit exceeded
          headers:
            Retry-After:
              description: Seconds until the next request may succeed
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
components:
  schemas:
    ExperimentDetail:
      type: object
      properties:
        id:
          type: string
          description: >-
            Experiment batch id. Some CLI commands historically call this a
            batch id.
        automationId:
          type: string
          description: Automation this experiment belongs to.
        automationType:
          $ref: '#/components/schemas/AutomationType'
        status:
          type: string
          enum:
            - queued
            - running
            - completed
          description: Experiment batch status.
        runCount:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Total runs in the experiment.
        completedCount:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Runs that have completed.
        passedCount:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Runs whose evaluator scores passed.
        failedCount:
          type: integer
          minimum: -9007199254740991
          maximum: 9007199254740991
          description: Runs whose evaluator scores failed.
        avgScore:
          anyOf:
            - type: number
            - type: 'null'
          description: Average automated evaluator score.
        createdAt:
          anyOf:
            - type: string
            - type: string
        completedAt:
          anyOf:
            - anyOf:
                - type: string
                - type: string
            - type: 'null'
        version:
          anyOf:
            - type: string
            - type: 'null'
        runs:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
                description: Run id created for the experiment.
              status:
                type: string
                description: Current run status.
              exampleId:
                anyOf:
                  - type: string
                  - type: 'null'
                description: Dataset example id for the run.
              exampleName:
                anyOf:
                  - type: string
                  - type: 'null'
                description: Dataset example name for the run.
              createdAt:
                anyOf:
                  - type: string
                  - type: string
              completedAt:
                anyOf:
                  - anyOf:
                      - type: string
                      - type: string
                  - type: 'null'
            required:
              - id
              - status
              - exampleId
              - exampleName
              - createdAt
              - completedAt
            additionalProperties: false
          description: Runs created for dataset examples in this experiment.
        resultsByRun:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/EvalResult'
          description: Evaluator results keyed by run id.
      required:
        - id
        - automationId
        - automationType
        - status
        - runCount
        - completedCount
        - passedCount
        - failedCount
        - avgScore
        - createdAt
        - completedAt
        - version
        - runs
        - resultsByRun
      additionalProperties: false
      description: Experiment batch detail.
    ApiErrorEnvelope:
      type: object
      properties:
        issues:
          type: array
          items:
            $ref: '#/components/schemas/ApiErrorIssue'
        requestId:
          type: string
          description: Request id echoed via the x-request-id header
        hint:
          description: Suggested fix for known error patterns
          type: string
        docsUrl:
          description: Link to relevant docs
          type: string
      required:
        - issues
        - requestId
      additionalProperties: false
    AutomationType:
      type: string
      enum:
        - workflow
        - agent
    EvalResult:
      type: object
      properties:
        id:
          type: string
          description: Evaluator result id.
        runId:
          type: string
          description: Run this score belongs to.
        automationId:
          anyOf:
            - type: string
            - type: 'null'
          description: Automation this score belongs to.
        evaluatorName:
          type: string
          description: Evaluator name from configuration.
        evaluatorType:
          type: string
          description: Evaluator implementation type.
        score:
          anyOf:
            - type: number
            - type: 'null'
          description: >-
            Automated evaluator score. Do not confuse this with a human review
            verdict.
        passed:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether this evaluator passed.
        label:
          anyOf:
            - type: string
            - type: 'null'
          description: Optional evaluator label.
        weight:
          anyOf:
            - type: number
            - type: 'null'
          description: Weight used in aggregate scoring.
        passThreshold:
          anyOf:
            - type: number
            - type: 'null'
          description: Score threshold required for this evaluator to pass.
        description:
          anyOf:
            - type: string
            - type: 'null'
          description: Evaluator description.
        details:
          anyOf:
            - {}
            - type: 'null'
          description: Evaluator-specific details.
        error:
          anyOf:
            - type: string
            - type: 'null'
          description: Evaluator error, when scoring failed.
        createdAt:
          anyOf:
            - type: string
            - type: string
      required:
        - id
        - runId
        - automationId
        - evaluatorName
        - evaluatorType
        - score
        - passed
        - label
        - weight
        - passThreshold
        - description
        - details
        - error
        - createdAt
      additionalProperties: false
      description: Automated evaluator result for one run.
    ApiErrorIssue:
      type: object
      properties:
        field:
          type: string
          description: JSON path of the offending field, or "<root>"
        message:
          type: string
          description: Human-readable error message
        code:
          type: string
          description: >-
            Machine-readable error code (e.g. invalid_value, not_found,
            api_trigger_disabled, manual_trigger_disabled)
        severity:
          type: string
          enum:
            - error
            - warning
          description: Issue severity
      required:
        - field
        - message
        - code
        - severity
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key issued from Settings → API Keys. Pass as `Authorization: Bearer
        <key>`.

````