Open AI (ChatGPT)
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 Japanese
  • 🇵🇹 Portuguese
  • 🇰🇷 Korea
  • 🇩🇪 German
  1. Chat
Open AI (ChatGPT)
🇺🇸 English
  • 🇺🇸 English
  • 🇯🇵 Japanese
  • 🇵🇹 Portuguese
  • 🇰🇷 Korea
  • 🇩🇪 German
  • README
  • Introduction
  • Authentication
  • Making requests
  • Streaming
  • Debugging requests
  • Backward compatibility
  • Administration
  • Audio
    • Create speech
      POST
    • Create transcription
      POST
    • Create translation
      POST
  • Chat
    • Create chat completion
      POST
  • Embeddings
    • Create embeddings
      POST
  • Fine-tuning
    • Create fine-tuning job
      POST
    • List fine-tuning jobs
      GET
    • List fine-tuning events
      GET
    • List fine-tuning checkpoints
      GET
    • Retrieve fine-tuning job
      GET
    • Cancel fine-tuning
      POST
  • Batch
    • Create batch
      POST
    • Retrieve batch
      GET
    • Cancel batch
      POST
    • List batch
      GET
  • Files
    • README
    • Upload file
      POST
    • List files
      GET
    • Retrieve file
      GET
    • Delete file
      DELETE
    • Retrieve file content
      GET
  • Uploads
    • Create upload
    • Add upload part
    • Complete upload
  • Images
    • README
    • Create image
    • Create image edit
    • Create image variation
  • Models
    • List models
    • Retrieve model
    • Delete a fine-tuned model
  • Moderations
    • Create moderation
  • Invites
    • List invites
    • Create invite
    • Retrieve invite
    • Delete invite
  • Users
    • List users
    • Modify user
    • Retrieve user
  • Projects
    • List projects
    • Create project
    • Retrieve project
    • Modify project
    • Archive project
  • Project users
    • List project users
    • Create project user
    • Retrieve project user
    • Modify project user
    • Delete project user
    • Create project service account
  • Project service accounts
    • List project service accounts
    • Create project service account
    • Retrieve project service account
    • Delete project service account
  • Project API keys
    • List project API keys
    • Retrieve project API key
    • Delete project API key
  • Project rate limits
    • List project rate limits
    • Modify project rate limit
  • Audit logs
    • List audit logs
  • Usage
    • Completions
    • Embeddings
    • Moderations
    • Images
    • Audio speeches
    • Audio transcriptions
    • Vector stores
    • Code interpreter sessions
    • Costs
  • Completions
    • Create completion
  • Assistants (v1)
    • Create assistant (v1)
    • Create assistant file (v1)
    • List assistants (v1)
    • List assistant files (v1)
    • Retrieve assistant (v1)
    • Retrieve assistant file (v1)
    • Modify assistant (v1)
    • Delete assistant (v1)
    • Delete assistant file (v1)
  • Threads (v1)
    • Create thread (v1)
    • Retrieve thread (v1)
    • Modify thread (v1)
    • Delete thread (v1)
  • Messages (v1)
    • Create message (v1)
    • List messages (v1)
    • List message files (v1)
    • Retrieve message (v1)
    • Retrieve message file (v1)
    • Modify message (v1)
  • Runs (v1)
    • Create run (v1)
    • Create thread and run (v1)
    • List runs (v1)
    • List run steps (v1)
    • Retrieve run (v1)
    • Retrieve run step (v1)
    • Modify run (v1)
    • Submit tool outputs to run (v1)
    • Cancel a run (v1)
  1. Chat

Create chat completion

POST
https://api.openai.com/v1/chat/completions
Creates a model response for the given chat conversation. Learn more in the text generation, vision, and audio guides.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.openai.com/v1/chat/completions' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
  "model": "gpt-3.5-turbo",
  "messages": [{"role": "user", "content": "Hello!"}]
}'
Response Response Example
{
  "id": "chatcmpl-123",
  "object": "chat.completion",
  "created": 1677652288,
  "choices": [
    {
      "index": 0,
      "message": {
        "role": "assistant",
        "content": "\n\nHello there, how may I assist you today?"
      },
      "finish_reason": "stop"
    }
  ],
  "usage": {
    "prompt_tokens": 9,
    "completion_tokens": 12,
    "total_tokens": 21
  }
}

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params
Content-Type
string 
required
Example:
application/json
Accept
string 
required
Example:
application/json
Authorization
string 
optional
Example:
Bearer {{YOUR_API_KEY}}
Body Params application/json
model
string 
required
ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.
messages
array [object {2}] 
required
A list of messages comprising the conversation so far. Example Python code.
role
string 
optional
The role of the messages author. One of system, user, assistant, or function.
content
string 
optional
The contents of the message. content is required for all messages except assistant messages with function calls.
temperature
integer 
optional
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.
top_p
integer 
optional
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.
n
integer 
optional
How many chat completion choices to generate for each input message.
stream
boolean 
optional
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.
stop
string 
optional
Up to 4 sequences where the API will stop generating further tokens.
max_tokens
integer 
optional
The maximum number of tokens to generate 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.
presence_penalty
number 
optional
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.
frequency_penalty
number 
optional
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.
logit_bias
null 
optional
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.
user
string 
optional
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.
Examples

Responses

🟢200OK
application/json
Body
id
string 
required
object
string 
required
created
integer 
required
choices
array [object {3}] 
required
index
integer 
optional
message
object 
optional
finish_reason
string 
optional
usage
object 
required
prompt_tokens
integer 
required
completion_tokens
integer 
required
total_tokens
integer 
required
Modified at 2025-01-17 03:35:09
Previous
Create translation
Next
Create embeddings
Built with