Body Required

• messages array[object] Required

  A list of messages comprising the conversation so far. Example Python code.

  At least 1 element.

  One of:

  System message object User message object Assistant message object Tool message object Function message object Deprecated

  Hide attributes Show attributes

  • content string Required

    The contents of the system message.

  • role string Required

    The role of the messages author, in this case system.

    Value is system.

  • name string

    An optional name for the participant. Provides the model information to differentiate between participants of the same role.

  Hide attributes Show attributes

  • content string | array[object] Required

    One of:

    Text content string Array of content parts array[object]

    The text contents of the message.

    An array of content parts with a defined type, each can be of type text or image_url when passing in images. You can pass multiple images by adding multiple image_url content parts. Image input is only supported when using the gpt-4-visual-preview model.

    At least 1 element.

    One of:

    Text content part object Image content part object

    Hide attributes Show attributes

    • type string Required

      The type of the content part.

      Value is text.

    • text string Required

      The text content.

    Hide attributes Show attributes

    • type string Required

      The type of the content part.

      Value is image_url.

    • image_url object Required
      Hide image_url attributes Show image_url attributes object

      • url string(uri) Required

        Either a URL of the image or the base64 encoded image data.

      • detail string

        Specifies the detail level of the image. Learn more in the Vision guide.

        Values are auto, low, or high. Default value is auto.

  • role string Required

    The role of the messages author, in this case user.

    Value is user.

  • name string

    An optional name for the participant. Provides the model information to differentiate between participants of the same role.

  Hide attributes Show attributes

  • content string | null

    The contents of the assistant message. Required unless tool_calls or function_call is specified.

  • role string Required

    The role of the messages author, in this case assistant.

    Value is assistant.

  • name string

    An optional name for the participant. Provides the model information to differentiate between participants of the same role.

  • tool_calls array[object]

    The tool calls generated by the model, such as function calls.

    Hide tool_calls attributes Show tool_calls attributes object

    • id string Required

      The ID of the tool call.

    • type string Required

      The type of the tool. Currently, only function is supported.

      Value is function.

    • function object Required

      The function that the model called.

      Hide function attributes Show function attributes object

      • name string Required

        The name of the function to call.

      • arguments string Required

        The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

  • function_call object | null Deprecated

    Deprecated and replaced by tool_calls. The name and arguments of a function that should be called, as generated by the model.

    Hide function_call attributes Show function_call attributes object | null Deprecated

    • arguments string Required

      The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.

    • name string Required

      The name of the function to call.

  Hide attributes Show attributes

  • role string Required

    The role of the messages author, in this case tool.

    Value is tool.

  • content string Required

    The contents of the tool message.

  • tool_call_id string Required

    Tool call that this message is responding to.

  Hide attributes Show attributes

  • role string Required

    The role of the messages author, in this case function.

    Value is function.

  • content string | null Required

    The contents of the function message.

  • name string Required

    The name of the function to call.

• model string Required

  Any of:

  string-1 string string-2 string

  ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

  ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.

  Values are gpt-4o, gpt-4o-2024-05-13, gpt-4-turbo, gpt-4-turbo-2024-04-09, gpt-4-0125-preview, gpt-4-turbo-preview, gpt-4-1106-preview, gpt-4-vision-preview, gpt-4, gpt-4-0314, gpt-4-0613, gpt-4-32k, gpt-4-32k-0314, gpt-4-32k-0613, gpt-3.5-turbo, gpt-3.5-turbo-16k, gpt-3.5-turbo-0301, gpt-3.5-turbo-0613, gpt-3.5-turbo-1106, gpt-3.5-turbo-0125, or gpt-3.5-turbo-16k-0613.

• frequency_penalty number | null

  Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.

  See more information about frequency and presence penalties.

  Minimum value is -2, maximum value is 2. Default value is 0.

• logit_bias object | null

  Modify the likelihood of specified tokens appearing in the completion.

  Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.

  Hide logit_bias attributes Show logit_bias attributes object | null

  • Additional properties
  • key integer
• logprobs boolean | null

  Whether to return log probabilities of the output tokens or not. If true, returns the log probabilities of each output token returned in the content of message.

  Default value is false.

• top_logprobs integer | null

  An integer between 0 and 20 specifying the number of most likely tokens to return at each token position, each with an associated log probability. logprobs must be set to true if this parameter is used.

  Minimum value is 0, maximum value is 20.

• max_tokens integer | null

  The maximum number of tokens that can be generated in the chat completion.

  The total length of input tokens and generated tokens is limited by the model's context length. Example Python code for counting tokens.

• n integer | null

  How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs.

  Minimum value is 1, maximum value is 128. Default value is 1.

• presence_penalty number | null

  Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.

  See more information about frequency and presence penalties.

  Minimum value is -2, maximum value is 2. Default value is 0.

• response_format object

  An object specifying the format that the model must output. Compatible with GPT-4 Turbo and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106.

  Setting to { "type": "json_object" } enables JSON mode, which guarantees the message the model generates is valid JSON.

  Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly "stuck" request. Also note that the message content may be partially cut off if finish_reason="length", which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

  Hide response_format attribute Show response_format attribute object

  • type string

    Must be one of text or json_object.

    Values are text or json_object. Default value is text.

• seed integer | null

  This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

  Minimum value is -9223372036854775808, maximum value is 9223372036854775807.

• stop string | null | array[string]

  One of:

  string-1 string | null array-2 array[string]

  Up to 4 sequences where the API will stop generating further tokens.

  Up to 4 sequences where the API will stop generating further tokens.

  At least 1 but not more than 4 elements.

• stream boolean | null

  If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. Example Python code.

  Default value is false.

• stream_options object | null

  Options for streaming response. Only set this when you set stream: true.

  Hide stream_options attribute Show stream_options attribute object | null

  • include_usage boolean

    If set, an additional chunk will be streamed before the data: [DONE] message. The usage field on this chunk shows the token usage statistics for the entire request, and the choices field will always be an empty array. All other chunks will also include a usage field, but with a null value.

• temperature number | null

  What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.

  We generally recommend altering this or top_p but not both.

  Minimum value is 0, maximum value is 2. Default value is 1.

• top_p number | null

  An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.

  We generally recommend altering this or temperature but not both.

  Minimum value is 0, maximum value is 1. Default value is 1.

• tools array[object]

  A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for. A max of 128 functions are supported.

  Hide tools attributes Show tools attributes object

  • type string Required

    The type of the tool. Currently, only function is supported.

    Value is function.

  • function object Required
    Hide function attributes Show function attributes object

    • description string

      A description of what the function does, used by the model to choose when and how to call the function.

    • name string Required

      The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

    • parameters object

      The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

      Omitting parameters defines a function with an empty parameter list.

      Hide parameters attribute Show parameters attribute object

      • Additional properties are allowed

• tool_choice string | object

  One of:

  string-1 string ChatCompletionNamedToolChoice object

  none means the model will not call any tool and instead generates a message. auto means the model can pick between generating a message or calling one or more tools. required means the model must call one or more tools.

  Values are none, auto, or required.

  Specifies a tool the model should use. Use to force the model to call a specific function.

  Hide attributes Show attributes

  • type string Required

    The type of the tool. Currently, only function is supported.

    Value is function.

  • function object Required
    Hide function attribute Show function attribute object

    • name string Required

      The name of the function to call.

• user string

  A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

• function_call string | object Deprecated

  One of:

  string-1 string ChatCompletionFunctionCallOption object

  none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function.

  Values are none or auto.

  Specifying a particular function via {"name": "my_function"} forces the model to call that function.

  Hide attribute Show attribute

  • name string Required

    The name of the function to call.

• functions array[object] Deprecated

  Deprecated in favor of tools.

  A list of functions the model may generate JSON inputs for.

  At least 1 but not more than 128 elements.

  Hide functions attributes Show functions attributes object Deprecated

  • description string

    A description of what the function does, used by the model to choose when and how to call the function.

  • name string Required

    The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.

  • parameters object

    The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format.

    Omitting parameters defines a function with an empty parameter list.

    Hide parameters attribute Show parameters attribute object

    • Additional properties are allowed