Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-264001921002.3 KB
OpenAI Integration
Azure Integration

Create chat completion (Azure OpenAI)

Creates a chat completion using Azure OpenAI deployment.

post/openai/openai/deployments/{deployment-id}/chat/completions

Path parameters

deployment-idstring required

Azure deployment ID

Query parameters

api-versionstring

Azure API version

Request body

modelstring required

Model identifier (e.g., gpt-4, gpt-3.5-turbo)

streamboolean

Whether to stream the response

max_tokensinteger

Maximum tokens to generate (legacy, use max_completion_tokens)

max_completion_tokensinteger

Maximum tokens to generate

temperaturenumber
top_pnumber
frequency_penaltynumber
presence_penaltynumber
logit_biasobject
logprobsboolean
top_logprobsinteger
ninteger
seedinteger
userstring
parallel_tool_callsboolean
response_formatobject

Format for the response

reasoning_effort'none' | 'minimal' | 'low' | 'medium' | 'high' | 'xhigh'

OpenAI reasoning effort level

service_tierstring
fallbacksstring[]

Fallback models

Example request

{
  "model": "gpt-4"
}

Response

Successful response

idstring
createdinteger
modelstring
objectstring
service_tierstring
system_fingerprintstring
citationsstring[]