This repository provides the official OpenAPI specification for the OpenAI API, enabling developers to understand and integrate with OpenAI's services. It serves as a definitive reference for API endpoints, request/response formats, and authentication methods, benefiting developers building applications that leverage AI models.

How It Works

The project is a static OpenAPI v3.0 specification document. It details all available API endpoints, including those for text generation, image creation, and embeddings. This structured format allows for automated client generation and validation, ensuring compatibility and simplifying integration.

Quick Start & Requirements

• The specification itself is a JSON file. No installation is required to view or use it.
• It can be consumed by OpenAPI tooling (e.g., Swagger UI, OpenAPI Generator).
• Official documentation and examples are available at https://platform.openai.com/docs/api-reference.

Highlighted Details

• Comprehensive definition of all OpenAI API endpoints.
• Includes request/response schemas, parameter types, and authentication details.
• Facilitates automated client generation for various programming languages.

Maintenance & Community

This is a public mirror of an internal specification. Pull requests are not accepted. Updates are managed internally by OpenAI.

Licensing & Compatibility

The specification is provided under the MIT License, allowing for broad use and integration.

Limitations & Caveats

This repository only contains the OpenAPI specification; it does not include client libraries or runtime code. Contributions are not accepted as it is a mirror of an internal specification.