Open AI (ChatGPT)
πŸ‡ΊπŸ‡Έ English
  • πŸ‡ΊπŸ‡Έ English
  • πŸ‡―πŸ‡΅ Japanese
  • πŸ‡΅πŸ‡Ή Portuguese
  • πŸ‡°πŸ‡· Korea
  • πŸ‡©πŸ‡ͺ German
    Open AI (ChatGPT)
    πŸ‡ΊπŸ‡Έ English
    • πŸ‡ΊπŸ‡Έ English
    • πŸ‡―πŸ‡΅ Japanese
    • πŸ‡΅πŸ‡Ή Portuguese
    • πŸ‡°πŸ‡· Korea
    • πŸ‡©πŸ‡ͺ German
    • README
    • Introduction
    • Authentication
    • Making requests
    • Streaming
    • Debugging requests
    • Backward compatibility
    • Administration
    • Chat
      • Create chat completion
        POST
      • Get chat completion
        GET
      • Get chat messages
        GET
      • List Chat Completions
        GET
      • Update chat completion
        POST
      • Delete chat completion
        DELETE
    • Audio
      • Create speech
        POST
      • Create transcription
        POST
      • Create translation
        POST
    • Images
      • README
      • Create image
        POST
      • Create image edit
        POST
      • Create image variation
        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
      • Retrieve batch
      • Cancel batch
      • List batch
    • Files
      • README
      • Upload file
      • List files
      • Retrieve file
      • Delete file
      • Retrieve file content
    • Uploads
      • Create upload
      • Add upload part
      • Complete upload
    • 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
    • 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
    • Usage
      • Completions
      • Embeddings
      • Moderations
      • Images
      • Audio speeches
      • Audio transcriptions
      • Vector stores
      • Code interpreter sessions
      • Costs
    • Assistants (v1)
      • Create assistant
      • List assistants
      • Delete assistant
      • Modify assistant
      • Retrieve assistant
      • Create assistant file (v1)
      • List assistant files (v1)
      • Retrieve assistant file (v1)
      • Delete assistant file (v1)

    Making requests

    You can paste the command below into your terminal to run your first API request. Make sure to replace $OPENAI_API_KEY with your secret API key. If you are using a legacy user key and you have multiple projects, you will also need to specify the Project Id. For improved security, we recommend transitioning to project based keys instead.
    This request queries the gpt-4o-mini model (which under the hood points to a gpt-4o-mini model variant) to complete the text starting with a prompt of "Say this is a test". You should get a response back that resembles the following:
    {
        "id": "chatcmpl-abc123",
        "object": "chat.completion",
        "created": 1677858242,
        "model": "gpt-4o-mini",
        "usage": {
            "prompt_tokens": 13,
            "completion_tokens": 7,
            "total_tokens": 20,
            "completion_tokens_details": {
                "reasoning_tokens": 0,
                "accepted_prediction_tokens": 0,
                "rejected_prediction_tokens": 0
            }
        },
        "choices": [
            {
                "message": {
                    "role": "assistant",
                    "content": "\n\nThis is a test!"
                },
                "logprobs": null,
                "finish_reason": "stop",
                "index": 0
            }
        ]
    }
    Now that you've generated your first chat completion, let's break down the response object. We can see the finish_reason is stop which means the API returned the full chat completion generated by the model without running into any limits. In the choices list, we only generated a single message but you can set the n parameter to generate multiple messages choices.
    Modified atΒ 2024-12-11 08:01:14
    Previous
    Authentication
    Next
    Streaming
    Built with