Azure OpenAI Service API

openapi: 3.1.0
info:
  title: Azure OpenAI Service REST API
  description: Azure OpenAI Service REST API provides access to OpenAI models hosted in Azure including
    GPT, embeddings, and image generation. Operations require a deployment name configured per model.
  version: '2024-10-21'
externalDocs:
  description: Azure OpenAI REST API Documentation
  url: https://learn.microsoft.com/en-us/azure/ai-services/openai/
servers:
- url: https://{resource}.openai.azure.com
  variables:
    resource:
      default: myresource
tags:
- name: Completions
- name: Chat
- name: Embeddings
- name: Images
security:
- apiKey: []
- azure_auth:
  - user_impersonation
paths:
  /openai/deployments/{deployment-id}/completions:
    parameters:
    - name: deployment-id
      in: path
      required: true
      schema:
        type: string
    - name: api-version
      in: query
      required: true
      schema:
        type: string
    post:
      operationId: createCompletion
      summary: AOAI Create completion
      description: Creates a text completion for the given prompt.
      tags:
      - Completions
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt:
                  type: string
                max_tokens:
                  type: integer
                temperature:
                  type: number
      responses:
        '200':
          description: Completion
          content:
            application/json:
              schema:
                type: object
  /openai/deployments/{deployment-id}/chat/completions:
    parameters:
    - name: deployment-id
      in: path
      required: true
      schema:
        type: string
    - name: api-version
      in: query
      required: true
      schema:
        type: string
    post:
      operationId: createChatCompletion
      summary: AOAI Create chat completion
      description: Creates a chat completion for a list of messages.
      tags:
      - Chat
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                messages:
                  type: array
                  items:
                    type: object
                temperature:
                  type: number
      responses:
        '200':
          description: Chat completion
          content:
            application/json:
              schema:
                type: object
  /openai/deployments/{deployment-id}/embeddings:
    parameters:
    - name: deployment-id
      in: path
      required: true
      schema:
        type: string
    - name: api-version
      in: query
      required: true
      schema:
        type: string
    post:
      operationId: createEmbedding
      summary: AOAI Create embeddings
      description: Generates embeddings for the input text.
      tags:
      - Embeddings
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                input:
                  type: string
      responses:
        '200':
          description: Embeddings
          content:
            application/json:
              schema:
                type: object
  /openai/deployments/{deployment-id}/images/generations:
    parameters:
    - name: deployment-id
      in: path
      required: true
      schema:
        type: string
    - name: api-version
      in: query
      required: true
      schema:
        type: string
    post:
      operationId: createImage
      summary: AOAI Generate image
      description: Generates images from a prompt.
      tags:
      - Images
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt:
                  type: string
                n:
                  type: integer
                size:
                  type: string
      responses:
        '200':
          description: Image generation
          content:
            application/json:
              schema:
                type: object
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key
    azure_auth:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/authorize
          scopes:
            user_impersonation: Impersonate user
x-generated-from: https://learn.microsoft.com/en-us/azure/ai-services/openai/
x-generated-by: claude-crawl-2026-05-08