Sign in
Chat

Call a deployment endpoint with specified tools and messages.

post/chat/completions

Request body

deploymentstring required
streamboolean
temperaturenumber
top_pnumber

Probability threshold for token selection in text generation, controlling output randomness.

ninteger
max_tokensinteger
knowledgebasesstring[]
task_idstring

Response

Successful response

idstring
objectstring
createdinteger
modelstring
task_idstring

Changes

Changed in 5 of the 24 revisions of this API.4214

  • 94dbe6af7da711See the full diff
    • ●

      removed the optional property choices/items/message/tool_calls/items/function/parameters from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property choices/items/message/tool_calls/items/function/arguments to the response with the 200 status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2e0c0d3d3fd312See the full diff
    • ●

      removed the optional property tool_calls from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property choices/items/message/tool_calls to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property task_id to the response with the 200 status

      response-optional-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 201c8d91a04525See the full diff
    • ▲

      the response property choices/items/message/content became optional for the status 200

      response-property-became-optional

    • ▲

      the response property choices/items/message/role became optional for the status 200

      response-property-became-optional

    • ○

      api operation id createChatCompletion removed and replaced with

      api-operation-id-removed

    • ○

      the endpoint scheme security bearerAuth was added to the API

      api-security-added

    • ○

      the endpoint scheme security apiKeyAuth was removed from the API

      api-security-removed

    • ○

      the request property messages/items/content became optional

      request-property-became-optional

    • ○

      the request property messages/items/role became optional

      request-property-became-optional

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ca4cd347cd3f25See the full diff
    • ▲

      the request property messages/items/content became required

      request-property-became-required

    • ▲

      the request property messages/items/role became required

      request-property-became-required

    • ○

      api operation id createChatCompletion was added

      api-operation-id-added

    • ○

      the endpoint scheme security apiKeyAuth was added to the API

      api-security-added

    • ○

      api tag Chat added

      api-tag-added

    • ○

      the response property choices/items/message/content became required for the status 200

      response-property-became-required

    • ○

      the response property choices/items/message/role became required for the status 200

      response-property-became-required

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e8e74f6a79e51See the full diff
    • ○

      endpoint added

      endpoint-added