openapi: 3.1.0
info:
  title: Microsoft Azure Azure OpenAI Service API
  description: >-
    Azure OpenAI Service provides REST API access to OpenAI's language models
    including GPT-4, GPT-4 Turbo, GPT-3.5-Turbo, and the Embeddings model
    series. These models can be adapted to tasks including content generation,
    summarization, semantic search, and natural language to code translation.
    Users access the service through REST APIs, Python SDK, or the web-based
    interface in the Azure AI Foundry portal.
  version: '2024-06-01'
  contact:
    name: Microsoft Azure Support
    url: https://azure.microsoft.com/en-us/support/
    email: azuresupport@microsoft.com
  license:
    name: Microsoft API License
    url: https://learn.microsoft.com/en-us/legal/
  x-logo:
    url: https://azure.microsoft.com/svghandler/azure-logo.png
servers:
- url: https://{endpoint}/openai
  description: Azure OpenAI Service endpoint
  variables:
    endpoint:
      default: your-resource-name.openai.azure.com
      description: >-
        The Azure OpenAI resource endpoint. Format:
        https://{resource-name}.openai.azure.com
security:
- apiKey: []
- oauth2:
  - https://cognitiveservices.azure.com/.default
tags:
- name: Audio
  description: Operations for audio transcription and translation
- name: Chat Completions
  description: Operations for chat-based completions
- name: Completions
  description: Operations for text completions
- name: Deployments
  description: Operations for managing model deployments
- name: Embeddings
  description: Operations for generating text embeddings
- name: Images
  description: Operations for image generation
- name: Models
  description: Operations for listing available models
paths:
  /deployments/{deployment-id}/chat/completions:
    post:
      operationId: ChatCompletions_Create
      summary: Microsoft Azure Create a Chat Completion
      description: >-
        Creates a completion for the chat message. Supports GPT-4, GPT-4 Turbo,
        and GPT-3.5-Turbo models.
      tags:
      - Chat Completions
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateChatCompletionRequest'
            examples:
              ChatcompletionsCreateRequestExample:
                summary: Default ChatCompletions_Create request
                x-microcks-default: true
                value:
                  messages:
                  - role: system
                    content: example_value
                    name: Example Title
                    tool_calls: {}
                    tool_call_id: '500123'
                  temperature: 42.5
                  top_p: 42.5
                  n: 10
                  stream: true
                  stop: example_value
                  max_tokens: 10
                  presence_penalty: 42.5
                  frequency_penalty: 42.5
                  response_format:
                    type: text
                  seed: 10
                  tools:
                  - type: function
                  tool_choice: example_value
                  user: example_value
      responses:
        '200':
          description: Successfully created a chat completion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateChatCompletionResponse'
              examples:
                ChatcompletionsCreate200Example:
                  summary: Default ChatCompletions_Create 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    object: chat.completion
                    created: 10
                    model: example_value
                    choices:
                    - index: 10
                      finish_reason: stop
                    usage:
                      prompt_tokens: 10
                      completion_tokens: 10
                      total_tokens: 10
                    system_fingerprint: example_value
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ChatcompletionsCreatedefaultExample:
                  summary: Default ChatCompletions_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments/{deployment-id}/completions:
    post:
      operationId: Completions_Create
      summary: Microsoft Azure Create a Text Completion
      description: >-
        Creates a completion for the provided prompt and parameters.
      tags:
      - Completions
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateCompletionRequest'
            examples:
              CompletionsCreateRequestExample:
                summary: Default Completions_Create request
                x-microcks-default: true
                value:
                  prompt: example_value
                  max_tokens: 10
                  temperature: 42.5
                  top_p: 42.5
                  n: 10
                  stream: true
                  stop: example_value
                  presence_penalty: 42.5
                  frequency_penalty: 42.5
                  user: example_value
      responses:
        '200':
          description: Successfully created a completion.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateCompletionResponse'
              examples:
                CompletionsCreate200Example:
                  summary: Default Completions_Create 200 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    object: text_completion
                    created: 10
                    model: example_value
                    choices:
                    - text: example_value
                      index: 10
                      finish_reason: stop
                    usage:
                      prompt_tokens: 10
                      completion_tokens: 10
                      total_tokens: 10
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                CompletionsCreatedefaultExample:
                  summary: Default Completions_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments/{deployment-id}/embeddings:
    post:
      operationId: Embeddings_Create
      summary: Microsoft Azure Create Embeddings
      description: >-
        Get a vector representation of a given input that can be easily consumed
        by machine learning models and algorithms.
      tags:
      - Embeddings
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmbeddingRequest'
            examples:
              EmbeddingsCreateRequestExample:
                summary: Default Embeddings_Create request
                x-microcks-default: true
                value:
                  input: example_value
                  user: example_value
                  input_type: example_value
                  encoding_format: float
                  dimensions: 10
      responses:
        '200':
          description: Successfully created embeddings.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEmbeddingResponse'
              examples:
                EmbeddingsCreate200Example:
                  summary: Default Embeddings_Create 200 response
                  x-microcks-default: true
                  value:
                    object: list
                    data:
                    - index: 10
                      object: embedding
                      embedding:
                      - {}
                    model: example_value
                    usage:
                      prompt_tokens: 10
                      completion_tokens: 10
                      total_tokens: 10
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                EmbeddingsCreatedefaultExample:
                  summary: Default Embeddings_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments/{deployment-id}/images/generations:
    post:
      operationId: ImageGenerations_Create
      summary: Microsoft Azure Create Image Generations
      description: Creates an image given a prompt using DALL-E models.
      tags:
      - Images
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateImageRequest'
            examples:
              ImagegenerationsCreateRequestExample:
                summary: Default ImageGenerations_Create request
                x-microcks-default: true
                value:
                  prompt: example_value
                  n: 10
                  size: 256x256
                  quality: standard
                  style: natural
                  response_format: url
                  user: example_value
      responses:
        '200':
          description: Successfully created image generations.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ImageGenerationsResponse'
              examples:
                ImagegenerationsCreate200Example:
                  summary: Default ImageGenerations_Create 200 response
                  x-microcks-default: true
                  value:
                    created: 10
                    data:
                    - url: https://www.example.com
                      b64_json: example_value
                      revised_prompt: example_value
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ImagegenerationsCreatedefaultExample:
                  summary: Default ImageGenerations_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments/{deployment-id}/audio/transcriptions:
    post:
      operationId: AudioTranscriptions_Create
      summary: Microsoft Azure Create Audio Transcription
      description: Transcribes audio into the input language using the Whisper model.
      tags:
      - Audio
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateTranscriptionRequest'
            examples:
              AudiotranscriptionsCreateRequestExample:
                summary: Default AudioTranscriptions_Create request
                x-microcks-default: true
                value:
                  file: example_value
                  language: example_value
                  prompt: example_value
                  response_format: json
                  temperature: 42.5
      responses:
        '200':
          description: Successfully transcribed the audio.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudioTranscriptionResponse'
              examples:
                AudiotranscriptionsCreate200Example:
                  summary: Default AudioTranscriptions_Create 200 response
                  x-microcks-default: true
                  value:
                    text: example_value
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AudiotranscriptionsCreatedefaultExample:
                  summary: Default AudioTranscriptions_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments/{deployment-id}/audio/translations:
    post:
      operationId: AudioTranslations_Create
      summary: Microsoft Azure Create Audio Translation
      description: Translates audio into English text using the Whisper model.
      tags:
      - Audio
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/CreateTranslationRequest'
            examples:
              AudiotranslationsCreateRequestExample:
                summary: Default AudioTranslations_Create request
                x-microcks-default: true
                value:
                  file: example_value
                  prompt: example_value
                  response_format: json
                  temperature: 42.5
      responses:
        '200':
          description: Successfully translated the audio.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AudioTranslationResponse'
              examples:
                AudiotranslationsCreate200Example:
                  summary: Default AudioTranslations_Create 200 response
                  x-microcks-default: true
                  value:
                    text: example_value
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AudiotranslationsCreatedefaultExample:
                  summary: Default AudioTranslations_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments/{deployment-id}/audio/speech:
    post:
      operationId: AudioSpeech_Create
      summary: Microsoft Azure Create Speech From Text
      description: Generates audio from the input text.
      tags:
      - Audio
      parameters:
      - $ref: '#/components/parameters/DeploymentIdParameter'
      - $ref: '#/components/parameters/ApiVersionParameter'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateSpeechRequest'
            examples:
              AudiospeechCreateRequestExample:
                summary: Default AudioSpeech_Create request
                x-microcks-default: true
                value:
                  model: tts-1
                  input: example_value
                  voice: alloy
                  response_format: mp3
                  speed: 42.5
      responses:
        '200':
          description: Successfully generated speech audio.
          content:
            application/octet-stream:
              schema:
                type: string
                format: binary
              examples:
                AudiospeechCreate200Example:
                  summary: Default AudioSpeech_Create 200 response
                  x-microcks-default: true
                  value: example_value
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                AudiospeechCreatedefaultExample:
                  summary: Default AudioSpeech_Create default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /models:
    get:
      operationId: Models_List
      summary: Microsoft Azure List Available Models
      description: >-
        Gets a list of all models that are accessible by the Azure OpenAI
        resource. These include base models as well as all successfully
        completed fine-tuned models owned by the Azure OpenAI resource.
      tags:
      - Models
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the list of models.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ModelListResponse'
              examples:
                ModelsList200Example:
                  summary: Default Models_List 200 response
                  x-microcks-default: true
                  value:
                    object: list
                    data:
                    - id: abc123
                      object: model
                      created: 10
                      owned_by: example_value
                      capabilities: {}
                      lifecycle_status: generally-available
                      deprecation: {}
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                ModelsListdefaultExample:
                  summary: Default Models_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /deployments:
    get:
      operationId: Deployments_List
      summary: Microsoft Azure List Deployments
      description: >-
        Gets the list of deployments owned by the Azure OpenAI resource.
      tags:
      - Deployments
      parameters:
      - $ref: '#/components/parameters/ApiVersionParameter'
      responses:
        '200':
          description: Successfully returned the list of deployments.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeploymentListResponse'
              examples:
                DeploymentsList200Example:
                  summary: Default Deployments_List 200 response
                  x-microcks-default: true
                  value:
                    object: list
                    data:
                    - id: abc123
                      object: deployment
                      created_at: '2026-01-15T10:30:00Z'
                      updated_at: '2026-01-15T10:30:00Z'
                      model: example_value
                      owner: example_value
                      status: succeeded
                      scale_settings: {}
        default:
          description: An error occurred.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                DeploymentsListdefaultExample:
                  summary: Default Deployments_List default response
                  x-microcks-default: true
                  value:
                    error:
                      code: example_value
                      message: example_value
                      param: example_value
                      type: example_value
                      inner_error:
                        code: example_value
                        content_filter_result: example_value
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    apiKey:
      type: apiKey
      name: api-key
      in: header
      description: Azure OpenAI API key authentication.
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: https://login.microsoftonline.com/common/oauth2/v2.0/authorize
          scopes:
            https://cognitiveservices.azure.com/.default: Access Azure OpenAI
  parameters:
    DeploymentIdParameter:
      name: deployment-id
      in: path
      required: true
      description: The deployment ID of the model to use for this request.
      schema:
        type: string
    ApiVersionParameter:
      name: api-version
      in: query
      required: true
      description: The API version to use for this operation.
      schema:
        type: string
        default: '2024-06-01'
  schemas:
    CreateChatCompletionRequest:
      type: object
      description: Request body for creating a chat completion.
      properties:
        messages:
          type: array
          description: >-
            A list of messages comprising the conversation so far.
          items:
            $ref: '#/components/schemas/ChatCompletionMessage'
          minItems: 1
          example: []
        temperature:
          type: number
          minimum: 0
          maximum: 2
          default: 1
          description: >-
            Sampling temperature between 0 and 2. Higher values make the output
            more random, while lower values make it more focused and deterministic.
          example: 42.5
        top_p:
          type: number
          minimum: 0
          maximum: 1
          default: 1
          description: >-
            An alternative to sampling with temperature called nucleus sampling.
          example: 42.5
        n:
          type: integer
          minimum: 1
          maximum: 128
          default: 1
          description: How many chat completion choices to generate for each input message.
          example: 10
        stream:
          type: boolean
          default: false
          description: If set, partial message deltas will be sent as server-sent events.
          example: true
        stop:
          description: Up to 4 sequences where the API will stop generating further tokens.
          oneOf:
          - type: string
          - type: array
            items:
              type: string
            minItems: 1
            maxItems: 4
          example: example_value
        max_tokens:
          type: integer
          description: >-
            The maximum number of tokens that can be generated in the chat
            completion.
          example: 10
        presence_penalty:
          type: number
          default: 0
          minimum: -2
          maximum: 2
          description: >-
            Positive values penalize new tokens based on whether they appear in
            the text so far.
          example: 42.5
        frequency_penalty:
          type: number
          default: 0
          minimum: -2
          maximum: 2
          description: >-
            Positive values penalize new tokens based on their existing frequency
            in the text so far.
          example: 42.5
        response_format:
          type: object
          description: An object specifying the format that the model must output.
          properties:
            type:
              type: string
              enum:
              - text
              - json_object
              description: The type of response format being defined.
          example: example_value
        seed:
          type: integer
          description: >-
            If specified, the system will make a best effort to sample
            deterministically.
          example: 10
        tools:
          type: array
          description: A list of tools the model may call.
          items:
            $ref: '#/components/schemas/ChatCompletionTool'
          example: []
        tool_choice:
          description: Controls which (if any) tool is called by the model.
          oneOf:
          - type: string
            enum:
            - none
            - auto
            - required
          - type: object
            properties:
              type:
                type: string
                enum:
                - function
              function:
                type: object
                properties:
                  name:
                    type: string
                required:
                - name
            required:
            - type
            - function
          example: example_value
        user:
          type: string
          description: A unique identifier representing your end-user.
          example: example_value
      required:
      - messages
    ChatCompletionMessage:
      type: object
      description: A message in the chat conversation.
      properties:
        role:
          type: string
          enum:
          - system
          - user
          - assistant
          - tool
          description: The role of the messages author.
          example: system
        content:
          description: The contents of the message.
          oneOf:
          - type: string
          - type: 'null'
          example: example_value
        name:
          type: string
          description: An optional name for the participant.
          example: Example Title
        tool_calls:
          type: array
          description: The tool calls generated by the model.
          items:
            $ref: '#/components/schemas/ChatCompletionToolCall'
          example: []
        tool_call_id:
          type: string
          description: Tool call that this message is responding to.
          example: '500123'
      required:
      - role
    ChatCompletionTool:
      type: object
      description: A tool the model may call.
      properties:
        type:
          type: string
          enum:
          - function
          description: The type of the tool.
          example: function
        function:
          $ref: '#/components/schemas/FunctionDefinition'
      required:
      - type
      - function
    FunctionDefinition:
      type: object
      description: The function definition.
      properties:
        name:
          type: string
          description: The name of the function to be called.
          example: Example Title
        description:
          type: string
          description: A description of what the function does.
          example: A sample description.
        parameters:
          type: object
          description: >-
            The parameters the functions accepts, described as a JSON Schema object.
          example: example_value
      required:
      - name
    ChatCompletionToolCall:
      type: object
      description: A tool call generated by the model.
      properties:
        id:
          type: string
          description: The ID of the tool call.
          example: abc123
        type:
          type: string
          enum:
          - function
          description: The type of the tool call.
          example: function
        function:
          type: object
          description: The function that the model called.
          properties:
            name:
              type: string
              description: The name of the function to call.
            arguments:
              type: string
              description: >-
                The arguments to call the function with, as generated by the
                model in JSON format.
          required:
          - name
          - arguments
          example: example_value
      required:
      - id
      - type
      - function
    CreateChatCompletionResponse:
      type: object
      description: Represents a chat completion response returned by model.
      properties:
        id:
          type: string
          description: A unique identifier for the chat completion.
          example: abc123
        object:
          type: string
          enum:
          - chat.completion
          description: The object type.
          example: chat.completion
        created:
          type: integer
          description: The Unix timestamp of when the chat completion was created.
          example: 10
        model:
          type: string
          description: The model used for the chat completion.
          example: example_value
        choices:
          type: array
          description: A list of chat completion choices.
          items:
            $ref: '#/components/schemas/ChatCompletionChoice'
          example: []
        usage:
          $ref: '#/components/schemas/Usage'
        system_fingerprint:
          type: string
          description: >-
            The system fingerprint representing the backend configuration.
          example: example_value
      required:
      - id
      - object
      - created
      - model
      - choices
    ChatCompletionChoice:
      type: object
      description: A chat completion choice.
      properties:
        index:
          type: integer
          description: The index of the choice in the list.
          example: 10
        message:
          $ref: '#/components/schemas/ChatCompletionMessage'
        finish_reason:
          type: string
          enum:
          - stop
          - length
          - content_filter
          - tool_calls
          description: The reason the model stopped generating tokens.
          example: stop
      required:
      - index
      - message
      - finish_reason
    CreateCompletionRequest:
      type: object
      description: Request body for creating a text completion.
      properties:
        prompt:
          description: >-
            The prompt(s) to generate completions for.
          oneOf:
          - type: string
          - type: array
            items:
              type: string
          example: example_value
        max_tokens:
          type: integer
          default: 16
          description: The maximum number of tokens that can be generated.
          example: 10
        temperature:
          type: number
          default: 1
          minimum: 0
          maximum: 2
          description: Sampling temperature to use.
          example: 42.5
        top_p:
          type: number
          default: 1
          minimum: 0
          maximum: 1
          description: Nucleus sampling parameter.
          example: 42.5
        n:
          type: integer
          default: 1
          minimum: 1
          maximum: 128
          description: How many completions to generate for each prompt.
          example: 10
        stream:
          type: boolean
          default: false
          description: Whether to stream back partial progress.
          example: true
        stop:
          description: Up to 4 sequences where the API will stop generating further tokens.
          oneOf:
          - type: string
          - type: array
            items:
              type: string
            maxItems: 4
          example: example_value
        presence_penalty:
          type: number
          default: 0
          minimum: -2
          maximum: 2
          description: Penalizes new tokens based on whether they appear in the text so far.
          example: 42.5
        frequency_penalty:
          type: number
          default: 0
          minimum: -2
          maximum: 2
          description: Penalizes new tokens based on their existing frequency in the text.
          example: 42.5
        user:
          type: string
          description: A unique identifier representing your end-user.
          example: example_value
      required:
      - prompt
    CreateCompletionResponse:
      type: object
      description: Represents a completion response from the API.
      properties:
        id:
          type: string
          description: A unique identifier for the completion.
          example: abc123
        object:
          type: string
          enum:
          - text_completion
          description: The object type.
          example: text_completion
        created:
          type: integer
          description: The Unix timestamp of when the completion was created.
          example: 10
        model:
          type: string
          description: The model used for completion.
          example: example_value
        choices:
          type: array
          description: The list of completion choices.
          items:
            type: object
            properties:
              text:
                type: string
                description: The generated text.
              index:
                type: integer
                description: The index of the choice.
              finish_reason:
                type: string
                enum:
                - stop
                - length
                - content_filter
                description: The reason the model stopped generating tokens.
          example: []
        usage:
          $ref: '#/components/schemas/Usage'
      required:
      - id
      - object
      - created
      - model
      - choices
    CreateEmbeddingRequest:
      type: object
      description: Request body for creating embeddings.
      properties:
        input:
          description: >-
            Input text to embed, encoded as a string or array of strings.
          oneOf:
          - type: string
          - type: array
            items:
              type: string
            minItems: 1
          example: example_value
        user:
          type: string
          description: A unique identifier representing your end-user.
          example: example_value
        input_type:
          type: string
          description: The input type for the embedding request.
          example: example_value
        encoding_format:
          type: string
          enum:
          - float
          - base64
          description: The format to return the embeddings in.
          example: float
        dimensions:
          type: integer
          minimum: 1
          description: The number of dimensions the resulting output embeddings should have.
          example: 10
      required:
      - input
    CreateEmbeddingResponse:
      type: object
      description: Response from the embeddings API.
      properties:
        object:
          type: string
          enum:
          - list
          description: The object type.
          example: list
        data:
          type: array
          description: The list of embeddings generated.
          items:
            type: object
            properties:
              index:
                type: integer
                description: The index of the embedding.
              object:
                type: string
                enum:
                - embedding
                description: The object type.
              embedding:
                type: array
                items:
                  type: number
                description: The embedding vector.
            required:
            - index
            - object
            - embedding
          example: []
        model:
          type: string
          description: The model used to generate the embeddings.
          example: example_value
        usage:
          $ref: '#/components/schemas/Usage'
      required:
      - object
      - data
      - model
      - usage
    CreateImageRequest:
      type: object
      description: Request body for creating image generations.
      properties:
        prompt:
          type: string
          description: A text description of the desired image(s).
          maxLength: 4000
          example: example_value
        n:
          type: integer
          minimum: 1
          maximum: 10
          default: 1
          description: The number of images to generate.
          example: 10
        size:
          type: string
          enum:
          - 256x256
          - 512x512
          - 1024x1024
          - 1792x1024
          - 1024x1792
          default: 1024x1024
          description: The size of the generated images.
          example: 256x256
        quality:
          type: string
          enum:
          - standard
          - hd
          default: standard
          description: The quality of the image that will be generated.
          example: standard
        style:
          type: string
          enum:
          - natural
          - vivid
          default: vivid
          description: The style of the generated images.
          example: natural
        response_format:
          type: string
          enum:
          - url
          - b64_json
          default: url
          description: The format in which the generated images are returned.
          example: url
        user:
          type: string
          description: A unique identifier representing your end-user.
          example: example_value
      required:
      - prompt
    ImageGenerationsResponse:
      type: object
      description: Response from the image generations API.
      properties:
        created:
          type: integer
          description: The Unix timestamp of when the images were created.
          example: 10
        data:
          type: array
          description: The list of generated images.
          items:
            type: object
            properties:
              url:
                type: string
                format: uri
                description: The URL of the generated image.
              b64_json:
                type: string
                description: The base64-encoded JSON of the generated image.
              revised_prompt:
                type: string
                description: The revised prompt that was used to generate the image.
          example: []
      required:
      - created
      - data
    CreateTranscriptionRequest:
      type: object
      description: Request body for creating an audio transcription.
      properties:
        file:
          type: string
          format: binary
          description: >-
            The audio file object to transcribe, in one of these formats: flac,
            mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm.
          example: example_value
        language:
          type: string
          description: >-
            The language of the input audio. Supplying the input language in
            ISO-639-1 format will improve accuracy and latency.
          example: example_value
        prompt:
          type: string
          description: >-
            An optional text to guide the model's style or continue a previous
            audio segment.
          example: example_value
        response_format:
          type: string
          enum:
          - json
          - text
          - srt
          - verbose_json
          - vtt
          default: json
          description: The format of the transcript output.
          example: json
        temperature:
          type: number
          default: 0
          description: The sampling temperature, between 0 and 1.
          example: 42.5
      required:
      - file
    AudioTranscriptionResponse:
      type: object
      description: Response from audio transcription.
      properties:
        text:
          type: string
          description: The transcribed text.
          example: example_value
      required:
      - text
    CreateTranslationRequest:
      type: object
      description: Request body for creating an audio translation.
      properties:
        file:
          type: string
          format: binary
          description: The audio file object to translate.
          example: example_value
        prompt:
          type: string
          description: An optional text to guide the model.
          example: example_value
        response_format:
          type: string
          enum:
          - json
          - text
          - srt
          - verbose_json
          - vtt
          default: json
          description: The format of the transcript output.
          example: json
        temperature:
          type: number
          default: 0
          description: The sampling temperature, between 0 and 1.
          example: 42.5
      required:
      - file
    AudioTranslationResponse:
      type: object
      description: Response from audio translation.
      properties:
        text:
          type: string
          description: The translated text.
          example: example_value
      required:
      - text
    CreateSpeechRequest:
      type: object
      description: Request body for generating speech from text.
      properties:
        model:
          type: string
          description: The TTS model to use.
          enum:
          - tts-1
          - tts-1-hd
          example: tts-1
        input:
          type: string
          maxLength: 4096
          description: The text to generate audio for.
          example: example_value
        voice:
          type: string
          enum:
          - alloy
          - echo
          - fable
          - onyx
          - nova
          - shimmer
          description: The voice to use when generating the audio.
          example: alloy
        response_format:
          type: string
          enum:
          - mp3
          - opus
          - aac
          - flac
          default: mp3
          description: The format to audio in.
          example: mp3
        speed:
          type: number
          minimum: 0.25
          maximum: 4.0
          default: 1.0
          description: The speed of the generated audio.
          example: 42.5
      required:
      - model
      - input
      - voice
    ModelListResponse:
      type: object
      description: Response listing available models.
      properties:
        object:
          type: string
          enum:
          - list
          example: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Model'
          example: []
      required:
      - object
      - data
    Model:
      type: object
      description: Describes an OpenAI model.
      properties:
        id:
          type: string
          description: The model identifier.
          example: abc123
        object:
          type: string
          enum:
          - model
          example: model
        created:
          type: integer
          description: The Unix timestamp when the model was created.
          example: 10
        owned_by:
          type: string
          description: The organization that owns the model.
          example: example_value
        capabilities:
          type: object
          description: The capabilities of the model.
          properties:
            fine_tune:
              type: boolean
            inference:
              type: boolean
            completion:
              type: boolean
            chat_completion:
              type: boolean
            embeddings:
              type: boolean
          example: example_value
        lifecycle_status:
          type: string
          enum:
          - generally-available
          - preview
          description: The lifecycle status of the model.
          example: generally-available
        deprecation:
          type: object
          description: Deprecation information for the model.
          properties:
            fine_tune:
              type: integer
              description: The Unix timestamp when fine-tuning will no longer be available.
            inference:
              type: integer
              description: The Unix timestamp when inference will no longer be available.
          example: example_value
      required:
      - id
      - object
      - created
    DeploymentListResponse:
      type: object
      description: Response listing deployments.
      properties:
        object:
          type: string
          enum:
          - list
          example: list
        data:
          type: array
          items:
            $ref: '#/components/schemas/Deployment'
          example: []
      required:
      - object
      - data
    Deployment:
      type: object
      description: Describes a model deployment.
      properties:
        id:
          type: string
          description: The deployment identifier.
          example: abc123
        object:
          type: string
          enum:
          - deployment
          example: deployment
        created_at:
          type: integer
          description: The Unix timestamp when the deployment was created.
          example: '2026-01-15T10:30:00Z'
        updated_at:
          type: integer
          description: The Unix timestamp when the deployment was last updated.
          example: '2026-01-15T10:30:00Z'
        model:
          type: string
          description: The model identifier deployed.
          example: example_value
        owner:
          type: string
          description: The owner of the deployment.
          example: example_value
        status:
          type: string
          enum:
          - succeeded
          - failed
          - running
          - canceled
          description: The current status of the deployment.
          example: succeeded
        scale_settings:
          type: object
          description: The deployment scale settings.
          properties:
            scale_type:
              type: string
              enum:
              - standard
              - manual
              description: The type of scaling.
            capacity:
              type: integer
              description: The deployment capacity.
          example: example_value
      required:
      - id
      - object
      - model
      - status
    Usage:
      type: object
      description: Usage statistics for the API call.
      properties:
        prompt_tokens:
          type: integer
          description: Number of tokens in the prompt.
          example: 10
        completion_tokens:
          type: integer
          description: Number of tokens in the generated completion.
          example: 10
        total_tokens:
          type: integer
          description: Total number of tokens used in the request.
          example: 10
      required:
      - prompt_tokens
      - total_tokens
    ErrorResponse:
      type: object
      description: Error response.
      properties:
        error:
          type: object
          description: The error object.
          properties:
            code:
              type: string
              description: The error code.
            message:
              type: string
              description: The error message.
            param:
              type: string
              description: The parameter that caused the error.
            type:
              type: string
              description: The error type.
            inner_error:
              type: object
              description: Inner error details.
              properties:
                code:
                  type: string
                  description: The inner error code.
                content_filter_result:
                  type: object
                  description: Content filter results, if applicable.
          required:
          - code
          - message
          example: example_value