Azure OpenAI Service Completions API

openapi: 3.1.0
info:
  title: Azure OpenAI Inference REST Audio Completions API
  version: '2024-10-21'
  description: 'Data-plane REST API for running inference against models deployed to an

    Azure OpenAI resource. Endpoints follow the pattern

    `https://{resource-name}.openai.azure.com/openai/deployments/{deployment-id}/{endpoint}?api-version={api-version}`.


    Authenticate with an `api-key` header or with a Microsoft Entra ID bearer token

    (`Authorization: Bearer ...`, scope `https://cognitiveservices.azure.com/.default`).

    '
  contact:
    name: Azure OpenAI Service
    url: https://learn.microsoft.com/en-us/azure/ai-services/openai/reference
servers:
- url: https://{resource-name}.openai.azure.com/openai
  description: Azure OpenAI resource endpoint
  variables:
    resource-name:
      default: my-resource
      description: Your Azure OpenAI resource name
tags:
- name: Completions
  description: Plain text completions
paths:
  /deployments/{deployment-id}/completions:
    post:
      summary: Create a text completion
      operationId: createCompletion
      tags:
      - Completions
      parameters:
      - in: path
        name: deployment-id
        required: true
        schema:
          type: string
      - in: query
        name: api-version
        required: true
        schema:
          type: string
          default: '2024-10-21'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                prompt:
                  type:
                  - string
                  - array
                max_tokens:
                  type: integer
                temperature:
                  type: number
                top_p:
                  type: number
                n:
                  type: integer
                stream:
                  type: boolean
                logprobs:
                  type: integer
                stop:
                  type:
                  - string
                  - array
      responses:
        '200':
          description: Completion response
          content:
            application/json:
              schema:
                type: object
      security:
      - apiKey: []
      - entra: []
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: api-key
      description: Azure OpenAI resource API key
    entra:
      type: oauth2
      description: Microsoft Entra ID OAuth 2.0 bearer token
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/common/oauth2/v2.0/token
          scopes:
            https://cognitiveservices.azure.com/.default: Azure Cognitive Services data plane