Create a chat completion (OpenAI compatible).
Request body
Response
chat completion response
Changes
Changed in 7 of the 19 revisions of this API.13637
- ○
the
response_formatrequest property default value{"type":"text","json_schema":{}}was removedrequest-property-default-value-removed
- ○
- ▲
removed
subschema #1subschema #2from thetool_choicerequest propertyanyOflistrequest-property-any-of-removed
- ▲
request property
messages/items/tool_calls/items/typewas restricted to a list of enum valuesrequest-property-became-enum
- ▲
the response property
choices/items/logprobsbecame nullable for the status200(media type: text/event-stream)response-property-became-nullable
- ▲
the response property
choices/items/message/contentbecame nullable for the status200(media type: application/json)response-property-became-nullable
- ▲
the response property
system_fingerprintbecame nullable for the status200(media type: application/json)response-property-became-nullable
- ▲
the
objectresponse property const valuechat.completionwas removed for the status200(media type: application/json)response-property-const-removed
- ▲
the
objectresponse property const valuechat.completion.chunkwas removed for the status200(media type: text/event-stream)response-property-const-removed
- ▲
the
typeresponse property const valuefunctionwas removed for the status200(media type: application/json)response-property-const-removed
- ▲
the
typeresponse property const valuefunctionwas removed for the status200(media type: text/event-stream)response-property-const-removed
- ●
the
max_completion_tokensrequest property's min was set to0.00request-property-min-set
- ●
added the new
chat.completionenum value to theobjectresponse property for the response status200(media type: application/json)response-property-enum-value-added
- ●
added the new
chat.completion.chunkenum value to theobjectresponse property for the response status200(media type: text/event-stream)response-property-enum-value-added
- ●
added the new
functionenum value to thechoices/items/delta/tool_calls/items/typeresponse property for the response status200(media type: text/event-stream)response-property-enum-value-added
- ●
added the new
functionenum value to thechoices/items/message/tool_calls/items/typeresponse property for the response status200(media type: application/json)response-property-enum-value-added
- ○
added
subschema #1subschema #2to thetool_choicerequest propertyanyOflistrequest-property-any-of-added
- ○
the request property
max_completion_tokensbecame nullablerequest-property-became-nullable
- ○
the request property
messages/items/contentbecame nullablerequest-property-became-nullable
- ○
the request property
response_format/json_schema/additionalProperties/became nullablerequest-property-became-nullable
- ○
the request property
temperaturebecame nullablerequest-property-became-nullable
- ○
the request property
tools/items/became nullablerequest-property-became-nullable
- ○
the request property
top_pbecame nullablerequest-property-became-nullable
- ○
the
typerequest property const valuefunctionwas removedrequest-property-const-removed
- ○
added the new
functionenum value to the request propertymessages/items/tool_calls/items/typerequest-property-enum-value-added
- ○
the
max_completion_tokensrequest property's exclusiveMinimum was decreased from0.00totruerequest-property-exclusive-min-decreased
- ▲
- ●
added the new
toolenum value to thechoices/items/message/roleresponse property for the response status200response-property-enum-value-added
- ○
added the optional property
choices/items/message/nameto the response with the200statusresponse-optional-property-added
- ○
added the optional property
choices/items/message/tool_call_idto the response with the200statusresponse-optional-property-added
- ○
added the optional property
choices/items/message/tool_callsto the response with the200statusresponse-optional-property-added
- ●
- ○
added the new optional request property
messages/items/namenew-optional-request-property
- ○
added the new optional request property
messages/items/tool_call_idnew-optional-request-property
- ○
added the new optional request property
messages/items/tool_callsnew-optional-request-property
- ○
the request property
messages/items/contentbecame nullablerequest-property-became-nullable
- ○
the request property
messages/items/contentbecame optionalrequest-property-became-optional
- ○
added the new
toolenum value to the request propertymessages/items/rolerequest-property-enum-value-added
- ○
- ▲
the request property
messages/items/contentbecame not nullablerequest-property-became-not-nullable
- ▲
the request property
messages/items/contentbecame requiredrequest-property-became-required
- ▲
the
messages/items/contentrequest property type/format changed fromnull/tostring/request-property-type-changed
- ○
added the optional property
service_tierto the response with the200statusresponse-optional-property-added
- ○
added the optional property
system_fingerprintto the response with the200statusresponse-optional-property-added
- ○
added the optional property
usageto the response with the200statusresponse-optional-property-added
- ○
added the required property
choicesto the response with the200statusresponse-required-property-added
- ○
added the required property
createdto the response with the200statusresponse-required-property-added
- ○
added the required property
idto the response with the200statusresponse-required-property-added
- ○
added the required property
modelto the response with the200statusresponse-required-property-added
- ○
added the required property
objectto the response with the200statusresponse-required-property-added
- ▲
- ○
added the new optional request property
tool_choicenew-optional-request-property
- ○
added the new optional request property
toolsnew-optional-request-property
- ○
- ▲
removed the enum value
toolof the request propertymessages/items/rolerequest-property-enum-value-removed
- ○
the request property
frequency_penaltybecame optionalrequest-property-became-optional
- ○
the request property
max_completion_tokensbecame optionalrequest-property-became-optional
- ○
the request property
presence_penaltybecame optionalrequest-property-became-optional
- ○
the request property
streambecame optionalrequest-property-became-optional
- ○
the request property
temperaturebecame optionalrequest-property-became-optional
- ○
the request property
top_pbecame optionalrequest-property-became-optional
- ○
the
response_formatrequest property default value{"type":"text","json_schema":{}}was addedrequest-property-default-value-added
- ▲