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

# Create Augmentation



## OpenAPI

````yaml /api-reference/openapi.json post /v1/augmentations
openapi: 3.1.0
info:
  title: Kite Platform API
  description: >-
    Public API for Kite. Authenticate with `Authorization: Bearer kite_...`, and
    send `Kite-Version: 2026-09-27` to pin the dated contract your code was
    written against (without it you get 2026-09-27). Every response carries the
    version that served it.
  version: '2026-09-27'
servers:
  - url: https://api.kiteml.com
    description: Kite Platform API
security:
  - bearerAuth: []
tags:
  - name: Augmentations
    description: Generate new episodes from a LeRobot dataset.
  - name: Training runs
    description: Fine-tune a policy on a dataset, one run per policy.
  - name: Twins
    description: Rebuild a robot episode as an interactable MuJoCo scene (private beta).
  - name: Catalog
    description: Policies, hardware tiers, and dataset inspection.
  - name: Operations
    description: Poll any run by its id.
  - name: Webhooks
    description: Endpoints that receive events, and the event log.
  - name: API keys
    description: The key making the request.
  - name: Usage
    description: Token usage and credit balance.
paths:
  /v1/augmentations:
    post:
      tags:
        - Augmentations
      summary: Create Augmentation
      operationId: create_augmentation_v1_augmentations_post
      parameters:
        - name: Idempotency-Key
          in: header
          required: false
          schema:
            anyOf:
              - type: string
                maxLength: 255
              - type: 'null'
            title: Idempotency-Key
        - $ref: '#/components/parameters/KiteVersion'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AugmentationCreate'
      responses:
        '202':
          description: The augmentation, processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Augmentation'
        '400':
          description: >-
            Invalid request (`parameter_invalid`, `unsupported_version`, ...);
            `param` names the field
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '401':
          description: Missing or invalid API key (`unauthenticated`)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '403':
          description: >-
            The key lacks a scope this route needs (`missing_scope`), or the
            feature is not enabled for the account
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: >-
            Conflicts with the resource's state or an earlier request (e.g.
            `not_cancelable`, `idempotency_key_reused`)
        '429':
          description: >-
            Rate or concurrency limited (`rate_limit_exceeded`,
            `concurrency_limit_exceeded`, `capacity_exceeded`); honor
            `Retry-After`
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
components:
  parameters:
    KiteVersion:
      name: Kite-Version
      in: header
      required: false
      description: >-
        The dated contract your code was written against. Without it you get
        2026-09-27; every response says which version served it.
      schema:
        type: string
        enum:
          - '2026-09-27'
        default: '2026-09-27'
  schemas:
    AugmentationCreate:
      properties:
        source:
          $ref: '#/components/schemas/AugmentationSource'
        instructions:
          type: string
          maxLength: 2000
          minLength: 3
          title: Instructions
        config:
          $ref: '#/components/schemas/AugmentationConfig'
        output:
          $ref: '#/components/schemas/AugmentationOutput'
        model:
          anyOf:
            - type: string
            - type: 'null'
          title: Model
          description: Augmentation model (default 'omni')
        webhook_metadata:
          anyOf:
            - type: object
            - type: 'null'
          title: Webhook Metadata
          description: Opaque metadata echoed on the resource and future webhook events
      type: object
      required:
        - source
        - instructions
      title: AugmentationCreate
    Augmentation:
      properties:
        id:
          type: string
          title: Id
          description: '`aug_` + a time-ordered ULID'
        object:
          type: string
          enum:
            - augmentation
          const: augmentation
          title: Object
          default: augmentation
        status:
          type: string
          enum:
            - processing
            - succeeded
            - failed
            - canceled
          title: Status
        progress:
          type: number
          maximum: 1
          minimum: 0
          title: Progress
          description: >-
            Of the current phase (import, generate, publish): it starts again
            from 0 at each
        status_message:
          anyOf:
            - type: string
            - type: 'null'
          title: Status Message
          description: What it is doing now, or the last thing it did
        error:
          anyOf:
            - $ref: '#/components/schemas/AugmentationError'
            - type: 'null'
          description: Set when `failed`
        model:
          type: string
          title: Model
          description: '`omni`'
        source:
          $ref: '#/components/schemas/AugmentationSource'
        instructions:
          type: string
          title: Instructions
        config:
          $ref: '#/components/schemas/AugmentationConfig'
        output:
          oneOf:
            - $ref: '#/components/schemas/AugmentationHuggingFaceOutput'
            - $ref: '#/components/schemas/AugmentationDownloadOutput'
          title: Output
          description: Where the episodes go, as given at create
          discriminator:
            propertyName: type
            mapping:
              download:
                $ref: '#/components/schemas/AugmentationDownloadOutput'
              huggingface:
                $ref: '#/components/schemas/AugmentationHuggingFaceOutput'
        tokens:
          $ref: '#/components/schemas/AugmentationTokens'
        webhook_metadata:
          anyOf:
            - type: object
            - type: 'null'
          title: Webhook Metadata
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
        - status
        - progress
        - model
        - source
        - instructions
        - config
        - output
        - tokens
      title: Augmentation
      description: >-
        One augmentation: new episodes generated from a Hugging Face LeRobot
        dataset, keeping its motion.
      examples:
        - config:
            episode_count: 3
          created_at: '2026-09-27T01:00:00Z'
          id: aug_01K62QZ8V4X9C3N7M5T2R8W6HB
          instructions: Make the table dark walnut and the light warm
          model: omni
          object: augmentation
          output:
            files:
              - bytes: 3186
                path: meta/info.json
                url: >-
                  https://storage.googleapis.com/kite-augment/augment/meta/info.json?X-Goog-Signature=abc
            type: download
          progress: 1
          source:
            repo_id: lerobot/svla_so101_pickplace
            type: huggingface
          status: succeeded
          status_message: Output published
          tokens:
            charged: 32670
          webhook_metadata:
            ref: run-42
    ApiErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      type: object
      required:
        - error
      title: ApiErrorResponse
      description: Every /v1 error has this shape.
    AugmentationSource:
      properties:
        type:
          type: string
          enum:
            - huggingface
          const: huggingface
          title: Type
          default: huggingface
        repo_id:
          type: string
          maxLength: 500
          minLength: 3
          title: Repo Id
          description: HF dataset id, e.g. 'lerobot/pusht'
      type: object
      required:
        - repo_id
      title: AugmentationSource
    AugmentationConfig:
      properties:
        episode_count:
          type: integer
          maximum: 500
          minimum: 1
          title: Episode Count
          description: Augmented episodes to generate
          default: 3
        variation_prompts:
          anyOf:
            - items:
                type: string
              type: array
              maxItems: 500
            - type: 'null'
          title: Variation Prompts
          description: One prompt per episode; overrides episode_count when provided
      type: object
      title: AugmentationConfig
    AugmentationOutput:
      properties:
        type:
          type: string
          enum:
            - huggingface
            - download
          title: Type
          default: download
        repo_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Repo Id
          description: Target HF dataset repo (required for type=huggingface)
        private:
          type: boolean
          title: Private
          default: true
      type: object
      title: AugmentationOutput
    AugmentationError:
      properties:
        code:
          type: string
          title: Code
          description: >-
            `system`, `generation`, `capacity`, `insufficient_tokens`,
            `dataset_unavailable`, `incompatible_dataset`, `hf_unauthorized`, or
            `pipeline_failed` when the run recorded no code
        message:
          anyOf:
            - type: string
            - type: 'null'
          title: Message
          description: What went wrong and what to do; safe to show a user
      type: object
      required:
        - code
      title: AugmentationError
    AugmentationHuggingFaceOutput:
      properties:
        type:
          type: string
          enum:
            - huggingface
          const: huggingface
          title: Type
          default: huggingface
        repo_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Repo Id
          description: The Hugging Face dataset the episodes are pushed to
        url:
          anyOf:
            - type: string
            - type: 'null'
          title: Url
          description: 'Once `succeeded`: the pushed dataset on huggingface.co'
      type: object
      title: AugmentationHuggingFaceOutput
    AugmentationDownloadOutput:
      properties:
        type:
          type: string
          enum:
            - download
          const: download
          title: Type
          default: download
        files:
          anyOf:
            - items:
                $ref: '#/components/schemas/AugmentationOutputFile'
              type: array
            - type: 'null'
          title: Files
          description: >-
            Only on GET /v1/augmentations/{id} once `succeeded`: every file of
            the LeRobot dataset. The key is absent everywhere else (lists,
            create, cancel, webhook events)
      type: object
      title: AugmentationDownloadOutput
    AugmentationTokens:
      properties:
        charged:
          type: integer
          title: Charged
          description: >-
            Charged up front when generation starts. Episodes that are never
            generated are refunded when it ends (see GET /v1/usage); the refund
            is not subtracted here
      type: object
      required:
        - charged
      title: AugmentationTokens
    ApiErrorBody:
      properties:
        type:
          type: string
          title: Type
          description: >-
            invalid_request_error, authentication_error, permission_error,
            not_found_error, conflict_error, rate_limit_error, or api_error
        code:
          type: string
          title: Code
          description: 'Machine-readable: branch on this, not on the message'
        message:
          type: string
          title: Message
        param:
          anyOf:
            - type: string
            - type: 'null'
          title: Param
          description: The request field the error is about, when there is one
        request_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Request Id
          description: Also in the X-Request-Id header; quote it to support
        details:
          anyOf:
            - type: object
            - type: 'null'
          title: Details
          description: >-
            Extra data for some codes (e.g. the cameras a dataset does have, for
            camera_not_found)
      type: object
      required:
        - type
        - code
        - message
      title: ApiErrorBody
    AugmentationOutputFile:
      properties:
        path:
          type: string
          title: Path
          description: Relative to the dataset root, e.g. `meta/info.json`
        bytes:
          type: integer
          title: Bytes
        url:
          type: string
          title: Url
          description: >-
            A signed storage link (no credentials; valid for an hour), or this
            API's own `/v1/augmentations/{id}/files/{path}` when signing is
            unavailable, which needs your Authorization header
      type: object
      required:
        - path
        - bytes
        - url
      title: AugmentationOutputFile
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Kite API key (`kite_...`), from **Platform API → Keys** in the
        dashboard.

````