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

# Get operation

> Poll an asynchronous operation. Terminal statuses: `succeeded`, `failed`, `cancelled`. Requires compute `read` access.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/gpu/operations/{operationId}
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/operations/{operationId}:
    get:
      tags:
        - GPU Infrastructure
      summary: Get operation
      description: >-
        Poll an asynchronous operation. Terminal statuses: `succeeded`,
        `failed`, `cancelled`. Requires compute `read` access.
      operationId: getOperation
      parameters:
        - name: operationId
          in: path
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                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)$
                  operationId:
                    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)$
                    description: Alias for `id`.
                  resourceId:
                    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)$
                  resourceType:
                    type: string
                    enum:
                      - pod
                      - volume
                      - cluster
                      - template
                      - registry
                      - ssh_key
                  action:
                    type: string
                    description: >-
                      Operation action, e.g. `pod_create`, `pod_stop`,
                      `cluster_create`, `cluster_terminate`, `volume_delete`,
                      `registry_rotate`.
                  state:
                    type: string
                    enum:
                      - pending
                      - in_progress
                      - succeeded
                      - failed
                      - cancelled
                      - reconciling
                    description: Alias for `status`.
                  status:
                    type: string
                    enum:
                      - pending
                      - in_progress
                      - succeeded
                      - failed
                      - cancelled
                      - reconciling
                    description: 'Terminal: `succeeded`, `failed`, `cancelled`.'
                  errorMessage:
                    nullable: true
                    description: >-
                      Sanitized failure reason. Never raw provider text or
                      secrets.
                    type: string
                  completedAt:
                    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)))$
                  failure:
                    nullable: true
                    description: >-
                      Structured reading of `errorMessage` once the operation is
                      `failed` or `cancelled`; null otherwise.
                    type: object
                    properties:
                      code:
                        type: string
                        description: >-
                          The same sanitized code as `errorMessage`, e.g.
                          `provider_rejected:no_capacity`.
                      actor:
                        type: string
                        enum:
                          - customer
                          - provider
                          - platform
                        description: >-
                          Whose action it is. `customer`: fix the request and
                          launch again. `provider`: nothing to fix; the
                          infrastructure provider could not serve this right
                          now. `platform`: AI Reserve's own standing or
                          credentials with the provider — ours to fix, nothing
                          about your request needs to change.
                      message:
                        type: string
                        description: >-
                          Plain-language explanation. Never names the provider,
                          a balance or a minimum.
                      next:
                        type: string
                        description: What to do next.
                    required:
                      - code
                      - actor
                      - message
                      - next
                    additionalProperties: false
                required:
                  - id
                  - operationId
                  - resourceId
                  - resourceType
                  - action
                  - state
                  - status
                  - errorMessage
                  - failure
                  - completedAt
                additionalProperties: false
                description: An asynchronous Compute operation record.
        '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.