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

# Augment seed data to generate synthetic data



## OpenAPI

````yaml https://raw.githubusercontent.com/getplumai/docs/refs/heads/main/api-reference/openapi.yaml post /augment
openapi: 3.0.0
info:
  title: Plum API
  version: 1.1.0
servers:
  - url: https://beta.getplum.ai/v1
security: []
paths:
  /augment:
    post:
      summary: Augment seed data to generate synthetic data
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                multiple:
                  type: integer
                  default: 1
                  maximum: 50
                  description: >-
                    Number of synthetic examples to generate per seed example
                    (max 50)
                eval_results_id:
                  type: string
                  description: >-
                    ID of evaluation results to use for target metrics (will use
                    latest if not provided)
                include_gathered:
                  type: boolean
                  default: false
                  description: >-
                    If true, includes gathered pairs (high-scoring and
                    positively critiqued) in the synthetic dataset
                pair_query:
                  type: object
                  description: Optional query parameters to filter seed dataset pairs
                  properties:
                    latest_n_pairs:
                      type: integer
                      description: >-
                        Maximum number of latest pairs to include (defaults to
                        MaxCorpusSize if not provided)
                    pair_labels:
                      type: array
                      items:
                        type: string
                      description: Filter pairs by labels (optional)
                target_metric_idx:
                  type: array
                  items:
                    type: integer
                  description: >-
                    Array of indices of target metrics for redrafting synthetic
                    data (from the evaluation results)
              required:
                - target_metric_idx
      responses:
        '200':
          description: Data successfully augmented
          content:
            application/json:
              schema:
                type: object
                properties:
                  synthetic_data_id:
                    type: string
                    description: ID of the generated synthetic dataset
                  created_at:
                    type: string
                    description: Timestamp when the synthetic data was created
                  seed_data_size:
                    type: integer
                    description: Number of pairs in the original seed dataset
                  synthetic_data_size:
                    type: integer
                    description: >-
                      Total number of pairs in the synthetic dataset (including
                      gathered pairs if include_gathered is true)
                  system_prompt:
                    type: string
                    description: System prompt used for the synthetic data
                  target_metrics:
                    type: array
                    items:
                      type: string
                    description: Array of target metrics that were used for redrafting
        '400':
          description: Bad request - malformed JSON or missing required fields
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '403':
          description: Forbidden - token count exceeds plan limit
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
        '500':
          description: Internal server error - various failures during augmentation process
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
      security:
        - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization

````