Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Azure OpenAI Service Chat Completions API

Chat-formatted text generation

Azure OpenAI Service Chat Completions API is one of 8 APIs that Azure OpenAI Service publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Chat Completions. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 2024-10-21.

Requests are made against a single base URL, https://{resource-name}.openai.azure.com/openai.

1 operations 1 paths 3 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
2024-10-21
Base URL
https://{your-resource-name}.openai.azure.com/openai
Authentication
API Key, OAuth 2.0
Resource Areas
1

Authentication & Security 2

Azure OpenAI Service Chat Completions API declares 2 security schemes for authenticating requests. An API key is passed in the header as api-key (apiKey). It supports OAuth 2.0 (entra) using the clientCredentials flow, exposing 1 scope.

  • apiKey — Azure OpenAI resource API key
  • entra — Microsoft Entra ID OAuth 2.0 bearer token

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Chat Completions 1

Chat-formatted text generation

POST
/deployments/{deployment-id}/chat/completions
Create a chat completion
createChatCompletion 2 params body → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ChatCompletionRequest (16 properties), ChatCompletionResponse (6 properties), ChatMessage (4 properties). Each schema is shown below with its type and property counts.

ChatCompletionRequest
object
16 properties 1 required
ChatCompletionResponse
object
6 properties
ChatMessage
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

azure-openai-chat-completions-api-openapi.yml Raw ↑

Other APIs Azure OpenAI Service publishes across the network.

Azure OpenAI Inference REST API
Azure OpenAI Responses API
Azure OpenAI Control Plane API
Azure OpenAI Service Audio API
Azure OpenAI Service Completions API
Azure OpenAI Service Embeddings API
Azure OpenAI Service Images API