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
    • 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)

    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