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)

    Debugging requests

    In addition to error codes returned from API responses, it may sometimes be necessary to inspect HTTP response headers as well. Of particular interest will be the headers which contain the unique ID of a particular API request, and information about rate limiting applied to your requests. Below is an incomplete list of HTTP headers returned with API responses:
    API meta information
    openai-organization: The organization associated with the request
    openai-processing-ms: Time taken processing your API request
    openai-version: REST API version used for this request (currently 2020-10-01)
    x-request-id: Unique identifier for this API request (used in troubleshooting)
    Rate limiting information
    x-ratelimit-limit-requests
    x-ratelimit-limit-tokens
    x-ratelimit-remaining-requests
    x-ratelimit-remaining-tokens
    x-ratelimit-reset-requests
    x-ratelimit-reset-tokens
    OpenAI recommends logging request IDs in production deployments, which will allow more efficient troubleshooting with our support team should the need arise. Our official SDKs provide a property on top level response objects containing the value of the x-request-id header.
    Request ID in Python
    Request ID in JavaScript

    Access raw response objects in SDKs#

    If you are using a lower-level HTTP client (like fetch or HttpClient in C#), you should already have access to response headers as a part of the HTTP interface.
    If you are using one of OpenAI's official SDKs (which largely abstract the HTTP request/response cycle), you will need to access raw HTTP responses in a slightly different way.
    Below is an example of accessing the raw response object (and the x-ratelimit-limit-tokens header) using our Python SDK.
    Here is how you'd access a raw response (and the x-ratelimit-limit-tokens header) using our JavaScript SDK.
    Modified at 2024-12-11 08:04:40
    Previous
    Streaming
    Next
    Backward compatibility
    Built with