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

# List pods

> All pods owned by your organization, including terminated ones. Requires compute `read` access.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/gpu/pods
openapi: 3.0.3
info:
  title: AI Reserve Gateway API
  description: >-
    The AI Reserve API surface — OpenAI-compatible chat completions,
    Anthropic-compatible messages, Bedrock Converse, images, video, files,
    text-to-speech, realtime voice sessions, and provider-hidden GPU
    infrastructure — 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: 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: 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.
paths:
  /v1/gpu/pods:
    get:
      tags:
        - GPU Infrastructure
      summary: List pods
      description: >-
        All pods owned by your organization, including terminated ones. Requires
        compute `read` access.
      operationId: listPods
      parameters:
        - name: cursor
          in: query
          required: false
          description: Opaque cursor from a previous page's `nextCursor`.
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      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)$
                        name:
                          type: string
                        status:
                          type: string
                          enum:
                            - requested
                            - provisioning
                            - starting
                            - running
                            - stopping
                            - stopped
                            - terminating
                            - terminated
                            - reconciling
                            - failed
                          description: Observed state reported by the reconciler.
                        desiredState:
                          type: string
                          enum:
                            - running
                            - stopped
                            - terminated
                          description: >-
                            Control-plane target state. The pod converges
                            asynchronously.
                        computeType:
                          type: string
                          enum:
                            - GPU
                            - CPU
                        cpuTypeId:
                          nullable: true
                          type: string
                        vcpuCount:
                          nullable: true
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        cloud:
                          type: string
                          enum:
                            - SECURE
                            - COMMUNITY
                        runpodTemplateId:
                          nullable: true
                          type: string
                        gpuTypeId:
                          nullable: true
                          type: string
                        gpuType:
                          nullable: true
                          description: Alias for `gpuTypeId`.
                          type: string
                        gpuCount:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                        dataCenterId:
                          type: string
                        datacenter:
                          type: string
                          description: Alias for `dataCenterId`.
                        containerDiskGb:
                          type: integer
                          minimum: -9007199254740991
                          maximum: 9007199254740991
                          description: >-
                            Ephemeral container disk in GiB. Destroyed on stop
                            or terminate.
                        volumeId:
                          nullable: true
                          description: Alias for `networkVolumeId`.
                          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)$
                        networkVolumeId:
                          nullable: true
                          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)$
                        volumeMountPath:
                          nullable: true
                          description: >-
                            Mount path of the attached network volume. Null when
                            no volume is attached.
                          type: string
                        imageName:
                          type: string
                        imageId:
                          type: string
                          description: Alias for `imageName`.
                        templateId:
                          nullable: true
                          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)$
                        registryCredentialId:
                          nullable: true
                          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)$
                        sshKeyIds:
                          type: array
                          items:
                            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)$
                        ports:
                          type: array
                          items:
                            type: object
                            properties:
                              port:
                                type: integer
                                minimum: 1
                                maximum: 65535
                              protocol:
                                type: string
                                enum:
                                  - http
                                  - tcp
                                  - udp
                            required:
                              - port
                              - protocol
                            additionalProperties: false
                          description: >-
                            Exposed ports as launched (template ports merged
                            in).
                        rateUsdPerHour:
                          type: string
                          pattern: ^\d+(?:\.\d{1,6})?$
                          description: >-
                            Locked hourly rate (GPU + container disk) accepted
                            at creation.
                        runningHourlyRateUsd:
                          type: string
                          pattern: ^\d+(?:\.\d{1,6})?$
                          description: Alias for `rateUsdPerHour`.
                        envKeys:
                          type: array
                          items:
                            type: string
                          description: >-
                            Names of injected environment variables. Values are
                            never returned.
                        paidThroughAt:
                          nullable: true
                          description: >-
                            End of the current prepaid coverage window. Null
                            when stopped or not yet running.
                          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)))$
                        lastError:
                          nullable: true
                          type: string
                        terminatedAt:
                          nullable: true
                          description: >-
                            Set once the pod is final: terminated, or a create
                            that failed before anything was provisioned. A final
                            pod bills nothing and accepts no lifecycle action;
                            `status` tells you which ending it was.
                          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
                        - name
                        - status
                        - desiredState
                        - gpuTypeId
                        - gpuType
                        - gpuCount
                        - dataCenterId
                        - datacenter
                        - containerDiskGb
                        - volumeId
                        - networkVolumeId
                        - volumeMountPath
                        - imageName
                        - imageId
                        - templateId
                        - registryCredentialId
                        - sshKeyIds
                        - ports
                        - rateUsdPerHour
                        - runningHourlyRateUsd
                        - envKeys
                        - paidThroughAt
                        - terminatedAt
                        - createdAt
                        - lastError
                      additionalProperties: false
                      description: >-
                        A GPU pod. Every non-secret attribute settable on create
                        is echoed here so declarative clients can diff against
                        live state.
                  nextCursor:
                    description: Pass as `?cursor=` to fetch the next page.
                    type: string
                required:
                  - data
                additionalProperties: false
        '400':
          description: Invalid request, missing Idempotency-Key, or schema violation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
        '401':
          description: Missing or invalid API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
        '403':
          description: Key lacks the required compute access (`read` or `manage`).
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
        '404':
          description: Resource not found or owned by another organization.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ComputeError'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    ComputeError:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
              enum:
                - invalid_request_error
                - authentication_error
                - permission_error
                - server_error
            param:
              nullable: true
              type: string
            code:
              type: string
              description: >-
                Machine-readable Compute error code, e.g. `quote_expired`,
                `price_changed`, `operation_conflict`, `no_capacity`,
                `volume_in_use`, `insufficient_funds`,
                `compute_access_required`, `not_found`.
            details:
              description: >-
                Machine-readable context for some codes. For `no_capacity` see
                `ComputeNoCapacityDetails`.
              type: object
              additionalProperties: {}
          required:
            - message
            - type
            - param
            - code
          additionalProperties: false
      required:
        - error
      additionalProperties: false
      description: OpenAI-shaped error envelope returned on every 4xx/5xx.
  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.