openapi: 3.0.3
info:
  title: Azure API Management Gateway AI APIs API
  description: The AI gateway capabilities in Azure API Management provide specialized features for managing, securing, and observing AI backend APIs including Azure OpenAI, OpenAI-compatible LLMs, MCP servers, and A2A agent APIs. Includes token rate limiting, semantic caching, load balancing across AI backends, and content safety enforcement.
  version: '2024-05-01'
  contact:
    name: Microsoft Azure
    url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
servers:
- url: https://{service-name}.azure-api.net
tags:
- name: APIs
paths:
  /apis:
    get:
      summary: List available APIs
      operationId: DevPortal_ListApis
      tags:
      - APIs
      description: Returns the list of published APIs available on the developer portal.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      responses:
        '200':
          description: List of APIs
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiList'
              examples:
                ApiListExample:
                  summary: List of available APIs
                  value:
                    count: 2
                    value:
                    - id: petstore-api
                      name: Petstore API
                      description: Manage pet inventory and orders.
                      serviceUrl: https://petstore.example.com
                    - id: weather-api
                      name: Weather API
                      description: Retrieve weather forecasts and current conditions.
                      serviceUrl: https://weather.example.com
              x-microcks-default:
                count: 2
  /apis/{api-id}:
    get:
      summary: Get API details
      operationId: DevPortal_GetApi
      tags:
      - APIs
      description: Returns details and documentation for a specific API.
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
      parameters:
      - name: api-id
        in: path
        required: true
        schema:
          type: string
        example: petstore-api
      responses:
        '200':
          description: API details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiDetail'
              examples:
                ApiDetailExample:
                  summary: API detail response
                  value:
                    id: petstore-api
                    name: Petstore API
                    description: Manage pet inventory and orders.
                    serviceUrl: https://petstore.example.com
                    protocols:
                    - https
                    subscriptionRequired: true
              x-microcks-default:
                id: petstore-api
                name: Petstore API
components:
  schemas:
    ApiDetail:
      type: object
      properties:
        id:
          type: string
          example: petstore-api
        name:
          type: string
          example: Petstore API
        description:
          type: string
          example: Manage pet inventory and orders.
        serviceUrl:
          type: string
          example: https://petstore.example.com
        protocols:
          type: array
          items:
            type: string
          example:
          - https
        subscriptionRequired:
          type: boolean
          example: true
    ApiSummary:
      type: object
      properties:
        id:
          type: string
          example: petstore-api
        name:
          type: string
          example: Petstore API
        description:
          type: string
          example: Manage pet inventory and orders.
        serviceUrl:
          type: string
          example: https://petstore.example.com
    ApiList:
      type: object
      properties:
        count:
          type: integer
          example: 2
        value:
          type: array
          items:
            $ref: '#/components/schemas/ApiSummary'
externalDocs:
  description: Documentation
  url: https://learn.microsoft.com/en-us/azure/api-management/genai-gateway-capabilities
x-generated-from: documentation