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

# Create an environment version

> Creates the next immutable version for an environment key. Existing workspaces remain pinned to their current version. Requires compute `manage` access.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/environments
openapi: 3.0.3
info:
  title: AI Reserve Gateway API
  description: >-
    The AI Reserve API surface — inference, durable environments, workspaces,
    sandboxes, executions, agent runs, GPU infrastructure, and fine-tuning — all
    behind one endpoint and one API key.
  version: 1.0.0
servers:
  - url: https://api.aireserve.com
security:
  - bearerAuth: []
tags:
  - name: Customers
    description: >-
      Per-end-customer usage, cost, and billable amounts for organizations that
      tag requests with their own customers.
  - name: Dedicated GPU endpoints
    description: >-
      OpenAI-compatible inference on your organization's own dedicated
      HuggingFace vLLM deployments, called with an ordinary AI Reserve API key.
      GPU time is billed from the wallet; requests add no per-token charge.
  - name: GPU Infrastructure
    description: >-
      Provision and manage provider-hidden GPU instances. The recommended
      Instances API accepts workload requirements and an hourly price ceiling;
      AI Reserve handles provider placement internally. Every mutation is
      asynchronous and returns an operation to poll.
  - name: Environments
    description: Immutable, versioned runtime definitions.
  - name: Workspaces
    description: Durable project storage pinned to one environment version.
  - name: Sandboxes
    description: >-
      Ephemeral provider-disclosed compute allocated from sealed quotes.
      Requests remain provider-neutral.
  - name: Executions
    description: Durable asynchronous operations and command, service, or agent executions.
  - name: Agent Runs
    description: Durable Agent SDK runs with replayable events and external artifacts.
  - name: Customer keys
    description: >-
      Mint, list, and revoke API keys pinned to your own end customers (and
      their organizations), so spend splits per customer without per-request
      tagging.
  - name: AWS CLI login
    description: >-
      Browser-authorization endpoints consumed by `aws login --profile …` (AWS
      CLI v2.32.0+). All three routes are unauthenticated — the caller has no
      credential until `/v1/token` succeeds.
  - name: Fine-tuning
    description: >-
      Fine-tune open models on your own data. Data lives in an S3 bucket inside
      your organization's AWS hub account; you name a base, LoRA or full, a
      price ceiling and how the result must be servable, and AI Reserve places
      the run on a backend internally. The result is a model in your bucket you
      can deploy or download.
  - name: 'Admin: Catalog'
    description: Discover the operations available to this token.
  - name: 'Admin: Analytics'
    description: Usage, spend and attribution reads.
  - name: 'Admin: API Keys'
    description: Organization and team inference keys.
  - name: 'Admin: Billing'
    description: Wallet, ledger and invoice reads.
  - name: 'Admin: Compute'
    description: GPU machines and persistent storage (quote, launch, inspect, stop).
  - name: 'Admin: Compute Runtime'
    description: >-
      Portable environments, workspaces, sandboxes, executions, operations and
      durable agent runs.
  - name: 'Admin: Containers'
    description: The organization's AWS account, ECS services, logs and secrets.
  - name: 'Admin: Files'
    description: Organization shared files.
  - name: 'Admin: Members'
    description: 'People in the organization: invite, profile, team, access, role.'
  - name: 'Admin: Models & Routing'
    description: Model availability, defaults, fallbacks and routing.
  - name: 'Admin: Organization'
    description: Retention, logging, branding, sign-in domains, classification.
  - name: 'Admin: Personal'
    description: The caller's own usage, budget, API keys and preferences.
  - name: 'Admin: Teams & Budgets'
    description: Teams, spend caps and allocations.
  - name: 'Admin: Training'
    description: Fine-tuning datasets, runs, models and deployments.
paths:
  /v1/environments:
    post:
      tags:
        - Environments
      summary: Create an environment version
      description: >-
        Creates the next immutable version for an environment key. Existing
        workspaces remain pinned to their current version. Requires compute
        `manage` access.
      operationId: createEnvironmentVersion
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          description: >-
            Client-selected key of 8–180 characters `[A-Za-z0-9:_-]`. Reusing it
            for the same action and canonical request replays the original
            result. Reusing it with a different request returns `409
            idempotency_conflict`.
          schema:
            type: string
            minLength: 8
            maxLength: 180
            pattern: ^[A-Za-z0-9:_-]+$
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEnvironmentRequest'
      responses:
        '201':
          description: Created.
          headers:
            Location:
              description: Canonical path of the created resource or accepted operation.
              schema:
                type: string
            Idempotency-Replayed:
              description: >-
                True when this response replays the result of an earlier request
                with the same key.
              schema:
                type: boolean
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Environment'
        '400':
          description: >-
            Invalid request, malformed event cursor, missing Idempotency-Key, or
            schema violation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeRuntimeError'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeRuntimeError'
        '403':
          description: The key lacks compute `manage` access.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeRuntimeError'
        '404':
          description: Resource not found or owned by another organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeRuntimeError'
        '409':
          description: >-
            State or retry conflict (`idempotency_conflict`, `invalid_state`,
            `operation_conflict`, `quote_mismatch`, or `quote_consumed`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeRuntimeError'
        '429':
          description: Rate limit exceeded.
          headers:
            Retry-After:
              description: Whole seconds before the caller should retry.
              schema:
                type: integer
                minimum: 1
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeRuntimeError'
        '500':
          description: Unexpected control-plane error (`internal_error`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeRuntimeError'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    CreateEnvironmentRequest:
      type: object
      properties:
        key:
          type: string
          minLength: 1
          maxLength: 120
          pattern: ^[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?$
        name:
          type: string
          minLength: 1
          maxLength: 255
        description:
          nullable: true
          type: string
          maxLength: 10000
        imageRef:
          type: string
          minLength: 1
          maxLength: 1024
        manifest:
          type: object
          properties:
            architecture:
              type: string
              enum:
                - amd64
                - arm64
            workingDirectory:
              type: string
              minLength: 1
              maxLength: 512
              pattern: ^\/(?:[A-Za-z0-9._-]+(?:\/[A-Za-z0-9._-]+)*)?$
            packages:
              maxItems: 256
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 255
            features:
              maxItems: 128
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 120
                pattern: ^[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?$
            environmentKeys:
              maxItems: 256
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 255
                pattern: ^[A-Za-z_][A-Za-z0-9_]*$
              description: >-
                Environment-variable names only. Values are injected when an
                execution starts and are never returned.
            agentHarnesses:
              maxItems: 32
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                    maxLength: 64
                    pattern: ^[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?$
                  argv:
                    minItems: 1
                    maxItems: 64
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 4096
                  workingDirectory:
                    type: string
                    minLength: 1
                    maxLength: 512
                    pattern: ^\/(?:[A-Za-z0-9._-]+(?:\/[A-Za-z0-9._-]+)*)?$
                  models:
                    minItems: 1
                    maxItems: 128
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 255
                  toolNames:
                    maxItems: 256
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 255
                  environmentKeys:
                    maxItems: 256
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 255
                      pattern: ^[A-Za-z_][A-Za-z0-9_]*$
                required:
                  - id
                  - argv
                  - models
                  - toolNames
                  - environmentKeys
                additionalProperties: false
              description: >-
                Explicit argv-only agent harness allowlist. Shell command
                templates are not accepted.
            networkPolicy:
              type: object
              properties:
                mode:
                  type: string
                  enum:
                    - open
                    - allowlist
                    - none
                domains:
                  maxItems: 256
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 253
                    pattern: >-
                      ^(?:\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
              required:
                - mode
                - domains
              additionalProperties: false
            secretReferences:
              maxItems: 256
              type: array
              items:
                type: object
                properties:
                  environmentKey:
                    type: string
                    minLength: 1
                    maxLength: 255
                    pattern: ^[A-Za-z_][A-Za-z0-9_]*$
                  secretId:
                    type: string
                    minLength: 1
                    maxLength: 255
                required:
                  - environmentKey
                  - secretId
                additionalProperties: false
              description: >-
                Reserved for tenant-scoped provider-vault bindings. Current
                compute providers require this array to be empty.
          required:
            - architecture
            - workingDirectory
            - packages
            - features
            - environmentKeys
            - agentHarnesses
            - networkPolicy
            - secretReferences
          additionalProperties: false
      required:
        - key
        - name
        - imageRef
        - manifest
      additionalProperties: false
      description: >-
        Creates the next immutable version for `key`; the server assigns
        `version` and `manifestHash`.
    Environment:
      type: object
      properties:
        id:
          type: string
          format: uuid
          pattern: >-
            ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
        object:
          type: string
          enum:
            - environment
        key:
          type: string
          minLength: 1
          maxLength: 120
          pattern: ^[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?$
        version:
          type: integer
          minimum: 0
          exclusiveMinimum: true
          maximum: 9007199254740991
        name:
          type: string
          minLength: 1
          maxLength: 255
        description:
          nullable: true
          type: string
          maxLength: 10000
        imageRef:
          type: string
          minLength: 1
          maxLength: 1024
        manifest:
          type: object
          properties:
            architecture:
              type: string
              enum:
                - amd64
                - arm64
            workingDirectory:
              type: string
              minLength: 1
              maxLength: 512
              pattern: ^\/(?:[A-Za-z0-9._-]+(?:\/[A-Za-z0-9._-]+)*)?$
            packages:
              maxItems: 256
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 255
            features:
              maxItems: 128
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 120
                pattern: ^[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?$
            environmentKeys:
              maxItems: 256
              type: array
              items:
                type: string
                minLength: 1
                maxLength: 255
                pattern: ^[A-Za-z_][A-Za-z0-9_]*$
              description: >-
                Environment-variable names only. Values are injected when an
                execution starts and are never returned.
            agentHarnesses:
              maxItems: 32
              type: array
              items:
                type: object
                properties:
                  id:
                    type: string
                    minLength: 1
                    maxLength: 64
                    pattern: ^[a-z0-9](?:[a-z0-9._-]*[a-z0-9])?$
                  argv:
                    minItems: 1
                    maxItems: 64
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 4096
                  workingDirectory:
                    type: string
                    minLength: 1
                    maxLength: 512
                    pattern: ^\/(?:[A-Za-z0-9._-]+(?:\/[A-Za-z0-9._-]+)*)?$
                  models:
                    minItems: 1
                    maxItems: 128
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 255
                  toolNames:
                    maxItems: 256
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 255
                  environmentKeys:
                    maxItems: 256
                    type: array
                    items:
                      type: string
                      minLength: 1
                      maxLength: 255
                      pattern: ^[A-Za-z_][A-Za-z0-9_]*$
                required:
                  - id
                  - argv
                  - models
                  - toolNames
                  - environmentKeys
                additionalProperties: false
              description: >-
                Explicit argv-only agent harness allowlist. Shell command
                templates are not accepted.
            networkPolicy:
              type: object
              properties:
                mode:
                  type: string
                  enum:
                    - open
                    - allowlist
                    - none
                domains:
                  maxItems: 256
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 253
                    pattern: >-
                      ^(?:\*\.)?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,63}$
              required:
                - mode
                - domains
              additionalProperties: false
            secretReferences:
              maxItems: 256
              type: array
              items:
                type: object
                properties:
                  environmentKey:
                    type: string
                    minLength: 1
                    maxLength: 255
                    pattern: ^[A-Za-z_][A-Za-z0-9_]*$
                  secretId:
                    type: string
                    minLength: 1
                    maxLength: 255
                required:
                  - environmentKey
                  - secretId
                additionalProperties: false
              description: >-
                Reserved for tenant-scoped provider-vault bindings. Current
                compute providers require this array to be empty.
          required:
            - architecture
            - workingDirectory
            - packages
            - features
            - environmentKeys
            - agentHarnesses
            - networkPolicy
            - secretReferences
          additionalProperties: false
        manifestHash:
          type: string
          pattern: ^[0-9a-f]{64}$
        state:
          type: string
          enum:
            - draft
            - active
            - deprecated
            - retired
        activatedAt:
          nullable: true
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
        deprecatedAt:
          nullable: true
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
        createdAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
        updatedAt:
          type: string
          format: date-time
          pattern: >-
            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
      required:
        - id
        - object
        - key
        - version
        - name
        - description
        - imageRef
        - manifest
        - manifestHash
        - state
        - activatedAt
        - deprecatedAt
        - createdAt
        - updatedAt
      additionalProperties: false
      description: >-
        An immutable environment version. Editing an environment creates another
        version.
    ComputeRuntimeError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
              minLength: 1
              maxLength: 4096
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - not_found_error
                - conflict_error
                - rate_limit_error
                - api_error
            param:
              nullable: true
              type: string
              maxLength: 255
            code:
              type: string
              enum:
                - invalid_request
                - authentication_failed
                - permission_denied
                - not_found
                - idempotency_conflict
                - invalid_state
                - unsupported_action
                - quote_expired
                - quote_mismatch
                - quote_consumed
                - no_capacity
                - insufficient_funds
                - operation_conflict
                - rate_limit_exceeded
                - provider_unavailable
                - internal_error
            details:
              type: object
              additionalProperties: {}
          required:
            - message
            - type
            - param
            - code
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: OpenAI-shaped error envelope returned for every JSON error response.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your AI Reserve API key (aireserve_api_…) from the API Keys page in the
        portal (https://portal.aireserve.com/keys).
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: The same API key sent as an `x-api-key` header.

````

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