openapi: 3.0.3
info:
  title: AMD Developer Cloud Configuration Instances API
  description: The AMD Developer Cloud API provides access to AMD Instinct GPU instances for AI inference, training, and HPC workloads. Supports managing compute instances, deploying AI models, monitoring GPU utilization, and integrating with ROCm-compatible frameworks including PyTorch, TensorFlow, and vLLM.
  version: '1'
  contact:
    name: AMD Developer Support
    url: https://developer.amd.com/support/
  termsOfService: https://www.amd.com/en/legal/terms-and-conditions.html
  license:
    name: AMD Terms and Conditions
    url: https://www.amd.com/en/legal/terms-and-conditions.html
servers:
- url: https://api.developer.amd.com/v1
  description: AMD Developer Cloud API Production
security:
- apiKey: []
tags:
- name: Instances
  description: GPU compute instance management
paths:
  /instances:
    get:
      operationId: listInstances
      summary: AMD Developer Cloud List GPU Instances
      description: Retrieve all active GPU compute instances in the authenticated account.
      tags:
      - Instances
      parameters:
      - name: status
        in: query
        required: false
        description: Filter by instance status.
        schema:
          type: string
          enum:
          - running
          - stopped
          - pending
          - terminated
      - name: gpuType
        in: query
        required: false
        description: Filter by GPU type (e.g., mi300x, mi250).
        schema:
          type: string
      - name: limit
        in: query
        required: false
        description: Maximum number of instances to return.
        schema:
          type: integer
          default: 20
      - name: offset
        in: query
        required: false
        description: Pagination offset.
        schema:
          type: integer
          default: 0
      responses:
        '200':
          description: List of GPU instances.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceList'
              examples:
                listInstances200Example:
                  summary: Default listInstances 200 response
                  x-microcks-default: true
                  value:
                    instances:
                    - id: inst-001
                      name: my-training-run
                      gpuType: mi300x
                      gpuCount: 8
                      status: running
                      region: us-west-2
                    total: 1
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                listInstances401Example:
                  summary: Default listInstances 401 response
                  x-microcks-default: true
                  value:
                    code: UNAUTHORIZED
                    message: Invalid API key
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createInstance
      summary: AMD Developer Cloud Create GPU Instance
      description: Launch a new AMD GPU compute instance with specified hardware configuration and ROCm environment.
      tags:
      - Instances
      requestBody:
        required: true
        description: Instance creation parameters.
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/InstanceInput'
            examples:
              createInstanceRequestExample:
                summary: Default createInstance request
                x-microcks-default: true
                value:
                  name: llm-training
                  gpuType: mi300x
                  gpuCount: 8
                  imageId: rocm-6.1-pytorch
                  region: us-west-2
      responses:
        '201':
          description: Instance created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instance'
              examples:
                createInstance201Example:
                  summary: Default createInstance 201 response
                  x-microcks-default: true
                  value:
                    id: inst-002
                    name: llm-training
                    gpuType: mi300x
                    gpuCount: 8
                    status: pending
                    region: us-west-2
        '401':
          description: Unauthorized.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                createInstance401Example:
                  summary: Default createInstance 401 response
                  x-microcks-default: true
                  value:
                    code: UNAUTHORIZED
                    message: Invalid API key
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /instances/{instanceId}:
    get:
      operationId: getInstance
      summary: AMD Developer Cloud Get GPU Instance
      description: Retrieve details of a specific GPU compute instance including status, configuration, and resource utilization.
      tags:
      - Instances
      parameters:
      - name: instanceId
        in: path
        required: true
        description: GPU instance identifier.
        schema:
          type: string
      responses:
        '200':
          description: Instance details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Instance'
              examples:
                getInstance200Example:
                  summary: Default getInstance 200 response
                  x-microcks-default: true
                  value:
                    id: inst-001
                    name: my-training-run
                    gpuType: mi300x
                    gpuCount: 8
                    status: running
                    region: us-west-2
        '404':
          description: Instance not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                getInstance404Example:
                  summary: Default getInstance 404 response
                  x-microcks-default: true
                  value:
                    code: NOT_FOUND
                    message: Instance not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: terminateInstance
      summary: AMD Developer Cloud Terminate GPU Instance
      description: Terminate and remove an AMD GPU compute instance.
      tags:
      - Instances
      parameters:
      - name: instanceId
        in: path
        required: true
        description: GPU instance identifier.
        schema:
          type: string
      responses:
        '204':
          description: Instance terminated.
        '404':
          description: Instance not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                terminateInstance404Example:
                  summary: Default terminateInstance 404 response
                  x-microcks-default: true
                  value:
                    code: NOT_FOUND
                    message: Instance not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Instance:
      type: object
      description: An AMD GPU compute instance.
      properties:
        id:
          type: string
          description: Instance identifier.
          example: inst-001
        name:
          type: string
          description: Instance display name.
          example: my-training-run
        gpuType:
          type: string
          description: GPU hardware type.
          enum:
          - mi300x
          - mi250
          - mi210
          - rx7900xtx
          example: mi300x
        gpuCount:
          type: integer
          description: Number of GPUs in the instance.
          example: 8
        status:
          type: string
          description: Current instance status.
          enum:
          - running
          - stopped
          - pending
          - terminated
          example: running
        region:
          type: string
          description: Deployment region.
          example: us-west-2
        imageId:
          type: string
          description: ROCm image used for the instance.
          example: rocm-6.1-pytorch
        createdAt:
          type: string
          format: date-time
          description: Instance creation timestamp.
    InstanceInput:
      type: object
      description: Request to create a GPU compute instance.
      required:
      - gpuType
      - gpuCount
      properties:
        name:
          type: string
          description: Display name for the instance.
          example: llm-training
        gpuType:
          type: string
          description: GPU hardware type.
          enum:
          - mi300x
          - mi250
          - mi210
          example: mi300x
        gpuCount:
          type: integer
          description: Number of GPUs to allocate.
          example: 8
        imageId:
          type: string
          description: ROCm environment image.
          example: rocm-6.1-pytorch
        region:
          type: string
          description: Deployment region.
          example: us-west-2
    ErrorResponse:
      type: object
      description: API error response.
      properties:
        code:
          type: string
          description: Error code.
          example: NOT_FOUND
        message:
          type: string
          description: Error message.
          example: The requested resource was not found.
    InstanceList:
      type: object
      description: List of GPU compute instances.
      properties:
        instances:
          type: array
          description: Array of instances.
          items:
            $ref: '#/components/schemas/Instance'
        total:
          type: integer
          description: Total number of instances.
          example: 3
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: X-API-Key