> ## 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 dataset review request

> Fetch one dataset review request with snapshotted items, progress, focus fields, ignored fields, and events.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/automations/{id}/dataset-review-requests/{reviewId}
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: Models
    description: >-
      List text, vision, and OCR models configured for the current tenant
      environment. This is a catalog inventory, not a live provider health
      probe.
  - name: Automations
    description: >-
      Inspect runnable workflow and agent automations, their versions, triggers,
      and source sync state. Move YAML workflows between folders and delete
      automations.
  - name: Folders
    description: >-
      Create and organize workflow and template folders. Deleting a folder
      unfiles contained workflows or templates and does not delete them.
  - 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: Templates
    description: >-
      Upload, inspect, version, download, and delete tenant-scoped DOCX and XLSX
      templates.
  - name: Email servers
    description: >-
      Create and manage outbound email servers for workflow mail. Secrets are
      encrypted at rest and never returned.
  - name: Evaluation
    description: >-
      Manage datasets, examples, evaluators, experiment batches, evaluator
      scores, and run promotion workflows.
paths:
  /v1/automations/{id}/dataset-review-requests/{reviewId}:
    get:
      tags:
        - Evaluation
      summary: Get dataset review request
      description: >-
        Fetch one dataset review request with snapshotted items, progress, focus
        fields, ignored fields, and events.
      operationId: automations.datasetReviewRequests.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: reviewId
          schema:
            type: string
            description: Dataset review request id.
          required: true
          description: Dataset review request id.
      responses:
        '200':
          description: Dataset review request.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetReviewDetail'
        '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'
        '503':
          description: >-
            Rate-limit accounting is temporarily unavailable. The request was
            not processed; retry.
          headers:
            Retry-After:
              description: Seconds until the next request may succeed
              schema:
                type: string
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorEnvelope'
components:
  schemas:
    DatasetReviewDetail:
      type: object
      properties:
        id:
          type: string
        automationId:
          type: string
        title:
          type: string
        instructions:
          anyOf:
            - type: string
            - type: 'null'
        focusFields:
          type: array
          items:
            $ref: '#/components/schemas/DatasetReviewFocusFieldOutput'
        ignoredFields:
          type: array
          items:
            type: string
        status:
          type: string
          enum:
            - draft
            - open
            - paused
            - closed
        exampleNames:
          type: array
          items:
            type: string
        progress:
          $ref: '#/components/schemas/DatasetReviewProgress'
        createdBy:
          anyOf:
            - type: string
            - type: 'null'
        createdAt:
          type: string
        closedAt:
          anyOf:
            - type: string
            - type: 'null'
        items:
          type: array
          items:
            $ref: '#/components/schemas/DatasetReviewItem'
        events:
          type: array
          items:
            $ref: '#/components/schemas/DatasetReviewEvent'
      required:
        - id
        - automationId
        - title
        - instructions
        - focusFields
        - ignoredFields
        - status
        - exampleNames
        - progress
        - createdBy
        - createdAt
        - closedAt
        - items
      additionalProperties: false
    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
        conflictingWorkflowId:
          description: >-
            Present on 409 workflow_name_conflict responses. Id of the workflow
            that already owns the requested name.
          type: string
      required:
        - issues
        - requestId
      additionalProperties: false
    DatasetReviewFocusFieldOutput:
      type: object
      properties:
        path:
          type: string
          minLength: 1
          description: >-
            Dotted expected-output path the reviewer should inspect, e.g.
            vendor.iban.
        reason:
          description: Optional reason this field needs attention.
          anyOf:
            - type: string
              minLength: 1
            - type: 'null'
      required:
        - path
      additionalProperties: false
    DatasetReviewProgress:
      type: object
      properties:
        total:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        pending:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        approved:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        edited:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        rejected:
          type: integer
          minimum: 0
          maximum: 9007199254740991
        remaining:
          type: integer
          minimum: 0
          maximum: 9007199254740991
          description: Count of examples still pending a decision.
        complete:
          type: boolean
          description: >-
            True when every example has been approved, edited, or rejected.
            Close the request when review is finished; dataset write-back is
            always manual.
      required:
        - total
        - pending
        - approved
        - edited
        - rejected
        - remaining
        - complete
      additionalProperties: false
    DatasetReviewItem:
      type: object
      properties:
        id:
          type: string
        reviewId:
          type: string
        exampleName:
          type: string
        snapshotInputJson:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
        snapshotExpectedJson:
          anyOf:
            - {}
            - type: 'null'
        snapshotManifest:
          type: object
          properties:
            expectedFiles:
              type: array
              items:
                type: object
                properties:
                  name:
                    type: string
                required:
                  - name
                additionalProperties: false
            metadata:
              anyOf:
                - type: object
                  propertyNames:
                    type: string
                  additionalProperties: {}
                - type: 'null'
            inputFileHashes:
              type: array
              items:
                type: object
                properties:
                  path:
                    type: string
                  sha256:
                    type: string
                required:
                  - path
                  - sha256
                additionalProperties: false
          required:
            - expectedFiles
            - metadata
          additionalProperties: false
        status:
          type: string
          enum:
            - pending
            - approved
            - edited
            - rejected
        currentExpectedJson:
          anyOf:
            - {}
            - type: 'null'
        fieldDecisions:
          type: object
          propertyNames:
            type: string
          additionalProperties:
            $ref: '#/components/schemas/DatasetReviewFieldDecision'
        inputDrifted:
          type: boolean
          description: >-
            True when live dataset input-file bytes no longer match the hashes
            captured at request creation.
        updatedBy:
          anyOf:
            - type: string
            - type: 'null'
        updatedAt:
          type: string
      required:
        - id
        - reviewId
        - exampleName
        - snapshotInputJson
        - snapshotExpectedJson
        - snapshotManifest
        - status
        - currentExpectedJson
        - fieldDecisions
        - inputDrifted
        - updatedBy
        - updatedAt
      additionalProperties: false
    DatasetReviewEvent:
      type: object
      properties:
        id:
          type: string
        reviewId:
          type: string
        itemId:
          anyOf:
            - type: string
            - type: 'null'
        actorUserId:
          anyOf:
            - type: string
            - type: 'null'
        action:
          type: string
          enum:
            - created
            - approved
            - edited
            - rejected
            - reopened
            - commented
            - field-decision
        diffSummary:
          anyOf:
            - {}
            - type: 'null'
        createdAt:
          type: string
      required:
        - id
        - reviewId
        - itemId
        - actorUserId
        - action
        - diffSummary
        - createdAt
      additionalProperties: false
    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
    DatasetReviewFieldDecision:
      type: object
      properties:
        decision:
          type: string
          enum:
            - approved
            - rejected
        comment:
          anyOf:
            - type: string
            - type: 'null'
        reviewerId:
          type: string
        updatedAt:
          type: string
      required:
        - decision
        - reviewerId
        - updatedAt
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key issued from Settings → API Keys. Pass as `Authorization: Bearer
        <key>`.

````