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

# Get Environment

> **Beta.** Usable today, but this endpoint can change before it is stable, without a new `Kite-Version`. Changes are announced before they ship.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/augmentations/environments/{env_id}
openapi: 3.1.0
info:
  title: Kite Platform API
  description: >-
    Public API for Kite. Authenticate with `Authorization: Bearer kite_...`, and
    send `Kite-Version: 2026-10-12` 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-10-12'
servers:
  - url: https://api.kiteml.com
    description: Kite Platform API
security:
  - bearerAuth: []
tags:
  - name: Augmentations
    description: Beta. 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 (beta, enabled per
      account).
  - name: RL runs
    description: >-
      Train a robot policy in simulation from a task spec; get the policy, its
      scene and a verdict.
  - name: Evaluations
    description: >-
      Evaluate a policy on a Kite SDK spec on Kite's machines: episodes,
      evaluators and a scorecard (beta).
  - name: Objects and environments
    description: Register your own objects and background scenes (beta).
  - name: Augmentation environments
    description: >-
      What an augmentation puts behind the work cell: from Kite's library, a
      photo, a prompt or a panorama (beta, enabled per account).
  - 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.
  - name: Requests
    description: >-
      The request log: every call of the last 30 days, who made it and how it
      ended.
  - name: Status
    description: Whether Kite is up, part by part. Needs no key.
paths:
  /v1/augmentations/environments/{env_id}:
    get:
      tags:
        - Augmentation environments
      summary: Get Environment
      description: >-
        **Beta.** Usable today, but this endpoint can change before it is
        stable, without a new `Kite-Version`. Changes are announced before they
        ship.
      operationId: get_environment_v1_augmentations_environments__env_id__get
      parameters:
        - name: env_id
          in: path
          required: true
          schema:
            type: string
            title: Env Id
        - $ref: '#/components/parameters/KiteVersion'
      responses:
        '200':
          description: The environment
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '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'
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiErrorResponse'
          description: >-
            No such resource (`resource_not_found`); another account's ids
            answer the same
        '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'
          - '2026-10-12'
        default: '2026-09-27'
  schemas:
    Environment:
      properties:
        object:
          type: string
          enum:
            - environment
          const: environment
          title: Object
          default: environment
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        kind:
          type: string
          enum:
            - panorama
            - world
          title: Kind
        source:
          type: string
          enum:
            - library
            - photo
            - prompt
            - upload
          title: Source
        owner:
          type: string
          enum:
            - kite
            - user
          title: Owner
          description: '`kite` for the library, `user` for yours'
        status:
          type: string
          enum:
            - processing
            - ready
            - failed
          title: Status
        library_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Library Id
          description: The library panorama it is, or was added from
        panorama_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Panorama Url
          description: >-
            The equirectangular panorama: GET it for a JPEG (`?width=`, default
            4096)
        world:
          anyOf:
            - $ref: '#/components/schemas/EnvironmentWorld'
            - type: 'null'
          description: 'Set for `kind: world` once ready'
        tags:
          $ref: '#/components/schemas/EnvironmentTags'
        license:
          anyOf:
            - type: string
            - type: 'null'
          title: License
          description: '`CC0-1.0` for the library'
        attribution:
          anyOf:
            - type: string
            - type: 'null'
          title: Attribution
        error:
          anyOf:
            - $ref: '#/components/schemas/EnvironmentError'
            - type: 'null'
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
      type: object
      required:
        - id
        - name
        - kind
        - source
        - owner
        - status
        - tags
      title: Environment
    ApiErrorResponse:
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      type: object
      required:
        - error
      title: ApiErrorResponse
      description: Every /v1 error has this shape.
    EnvironmentWorld:
      properties:
        metric_scale:
          anyOf:
            - type: number
            - type: 'null'
          title: Metric Scale
          description: World units to metres
        collider:
          type: boolean
          title: Collider
          description: Whether the world has a collision mesh
      type: object
      required:
        - collider
      title: EnvironmentWorld
    EnvironmentTags:
      properties:
        category:
          anyOf:
            - type: string
            - type: 'null'
          title: Category
        lighting:
          anyOf:
            - type: string
              enum:
                - daylight
                - artificial
            - type: 'null'
          title: Lighting
          description: >-
            As the caller gave it, else measured: `daylight` when the brightest
            light comes through the walls (windows), else `artificial`
        blue_red:
          anyOf:
            - type: number
            - type: 'null'
          title: Blue Red
          description: 'White balance: mean blue over mean red near the horizon'
        brightness:
          anyOf:
            - type: number
            - type: 'null'
          title: Brightness
          description: Mean luma near the horizon, 0 to 1
        daylight_yaw_deg:
          anyOf:
            - type: number
            - type: 'null'
          title: Daylight Yaw Deg
          description: >-
            Longitude of the brightest horizon direction; 0 is the panorama's
            centre, positive to the right
        scenery_depth_m:
          anyOf:
            - type: number
            - type: 'null'
          title: Scenery Depth M
          description: >-
            Distance to the walls, in metres: as the caller gave it, measured on
            a world, else estimated from the category
        width:
          anyOf:
            - type: integer
            - type: 'null'
          title: Width
        height:
          anyOf:
            - type: integer
            - type: 'null'
          title: Height
      type: object
      title: EnvironmentTags
      description: >-
        Measured on the panorama when it is added, plus what the caller said
        about the place.
    EnvironmentError:
      properties:
        code:
          type: string
          title: Code
          description: '`generation_failed` or `interrupted`; create the environment again'
        message:
          type: string
          title: Message
      type: object
      required:
        - code
        - message
      title: EnvironmentError
    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
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        A Kite API key (`kite_...`), from **Platform API → Keys** in the
        dashboard.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.