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)

    Authentication

    API keys#

    The OpenAI API uses API keys for authentication. You can create API keys at a user or service account level. Service accounts are tied to a "bot" individual and should be used to provision access for production systems. Each API key can be scoped to one of the following,
    1.
    Project keys - Provides access to a single project (preferred option); access Project API keys by selecting the specific project you wish to generate keys against.
    2.
    User keys - Our legacy keys. Provides access to all organizations and all projects that user has been added to; access API Keys to view your available keys. We highly advise transitioning to project keys for best security practices, although access via this method is currently still supported.
    Remember that your API key is a secret! Do not share it with others or expose it in any client-side code (browsers, apps). Production requests must be routed through your own backend server where your API key can be securely loaded from an environment variable or key management service.
    All API requests should include your API key in an Authorization HTTP header as follows:

    Organizations and projects (optional)#

    For users who belong to multiple organizations or are accessing their projects through their legacy user API key, you can pass a header to specify which organization and project is used for an API request. Usage from these API requests will count as usage for the specified organization and project.
    To access the Default project in an organization, leave out the `OpenAI-Project header
    Example curl command:
    Example with the openai Python package:
    Example with the openai Node.js package:
    Organization IDs can be found on your Organization settings page. Project IDs can be found on your General settings page by selecting the specific project.
    Modified at 2024-12-11 07:57:19
    Previous
    Introduction
    Next
    Making requests
    Built with