Sign in

v1

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

Create response (Azure OpenAI)

post/openai/openai/deployments/{deployment-id}/responses

Path parameters

deployment-idstring required

Azure deployment ID

Query parameters

api-versionstring

Request body

modelstring required

Model identifier

streamboolean
instructionsstring

System instructions for the model

max_output_tokensinteger
metadataobject
parallel_tool_callsboolean
previous_response_idstring
storeboolean
temperaturenumber
top_pnumber
truncation'auto' | 'disabled'
userstring
fallbacksstring[]

Example request

{
  "model": "gpt-4"
}

Response

Successful response

idstring
backgroundboolean
conversationobject
created_atinteger
includestring[]
instructionsobject
max_output_tokensinteger
max_tool_callsinteger
metadataobject
modelstring
parallel_tool_callsboolean
previous_response_idstring
promptobject
prompt_cache_keystring
safety_identifierstring
service_tierstring
status'completed' | 'failed' | 'in_progress' | 'canceled' | 'queued' | 'incomplete'
stop_reasonstring
storeboolean
temperaturenumber
top_logprobsinteger
top_pnumber
truncationstring
citationsstring[]