> ## 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.

# Create dataset example

> Create one dataset example from JSON fields. Use dataset import for archive-based uploads and file-bearing examples.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/automations/{id}/examples
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}/examples:
    post:
      tags:
        - Evaluation
      summary: Create dataset example
      description: >-
        Create one dataset example from JSON fields. Use dataset import for
        archive-based uploads and file-bearing examples.
      operationId: automations.examples.create
      parameters:
        - in: path
          name: id
          schema:
            type: string
            description: >-
              Automation id or typed alias, such as `workflows.slug` or
              `agents.slug`.
          required: true
          description: >-
            Automation id or typed alias, such as `workflows.slug` or
            `agents.slug`.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DatasetExampleMutation'
      responses:
        '201':
          description: Created dataset example.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DatasetExample'
        '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:
    DatasetExampleMutation:
      type: object
      properties:
        name:
          description: >-
            Example name. Required on create; omitted or null uses a generated
            name where supported.
          anyOf:
            - type: string
              minLength: 1
              maxLength: 128
            - type: 'null'
        input:
          description: Input arguments for the example.
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
        expected:
          description: Expected JSON output. Null clears the expected output.
          anyOf:
            - {}
            - type: 'null'
        metadata:
          description: Caller-managed metadata.
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
        annotation:
          description: Human note about the example. Null clears the annotation.
          anyOf:
            - type: string
              maxLength: 2000
            - type: 'null'
        rowOrder:
          description: Optional display order. Null clears the order.
          anyOf:
            - type: integer
              minimum: 0
              maximum: 9007199254740991
            - type: 'null'
        overrides:
          description: Step output overrides used during example runs.
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
      description: Fields used to create or update a dataset example.
    DatasetExample:
      type: object
      properties:
        id:
          type: string
          description: >-
            Stable public example id. Workflow examples use DB ids; agent
            examples use deterministic name-derived ids.
        name:
          type: string
          description: Human-readable dataset example name.
        automationId:
          type: string
          description: Automation that owns this example.
        automationType:
          $ref: '#/components/schemas/AutomationType'
        input:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
          description: Input arguments used when this example is run.
        expected:
          anyOf:
            - {}
            - type: 'null'
          description: Expected JSON output for evaluator comparisons.
        expectedFiles:
          type: array
          items:
            type: object
            properties:
              name:
                type: string
                description: Expected file name.
              url:
                description: Download URL for the expected file.
                type: string
            required:
              - name
            additionalProperties: false
          description: Expected files attached to this example.
        metadata:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
          description: Caller-managed metadata for sorting or filtering examples.
        annotation:
          anyOf:
            - type: string
            - type: 'null'
          description: Human note about the example.
        rowOrder:
          anyOf:
            - type: number
            - type: 'null'
          description: Optional display order within the dataset.
        overrides:
          anyOf:
            - type: object
              propertyNames:
                type: string
              additionalProperties: {}
            - type: 'null'
          description: Step output overrides used when running this example.
        latestRunId:
          anyOf:
            - type: string
            - type: 'null'
          description: Most recent run id created from this example.
        createdAt:
          anyOf:
            - type: string
            - type: string
        updatedAt:
          anyOf:
            - anyOf:
                - type: string
                - type: string
            - type: 'null'
      required:
        - id
        - name
        - automationId
        - automationType
        - input
        - expected
        - expectedFiles
        - metadata
        - annotation
        - rowOrder
        - overrides
        - latestRunId
      additionalProperties: false
      description: One input/expected-output row in an automation dataset.
    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
    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>`.

````