openai-openapi

OpenAPI specification for the OpenAI API

What is openai-openapi?

OpenAPI specification for the OpenAI API

Overview of openai-openapi

What it is

This repository publishes the OpenAPI specification for the OpenAI API. The specification is authored in OpenAPI 3.1 and provides a machine-readable description of the OpenAI REST API. It describes the API's endpoints, authentication methods, parameters, and request and response schemas. The files openapi.yaml and openapi.json are generated artifacts that are synchronized automatically from an upstream source.

Key features

  • Provides a complete OpenAPI 3.1 specification for the OpenAI REST API.
  • Includes definitions for endpoints, authentication, parameters, and schemas.
  • Available in both YAML and JSON formats.
  • Can be used to generate typed clients, build API explorers, and configure testing tools.
  • Official SDKs in Python, JavaScript/TypeScript, .NET, Go, Java, and Ruby are generated from this specification.
  • The specification is open source under the MIT License.

Use cases

Developers can use this specification to integrate with the OpenAI API in any OpenAPI-compatible workflow. It is suitable for generating client libraries, creating API documentation, setting up automated testing, and building custom API explorers. The specification also serves as a reference for understanding the structure of the OpenAI API.

Getting started

To download the latest YAML version of the specification, run: sh curl -L https://raw.githubusercontent.com/openai/openai-openapi/main/openapi.yaml -o openai-openapi.yaml The document can then be imported into tools that support the OpenAPI ecosystem.

License and pricing

This project is licensed under the MIT License. The pricing type is open source.

Based on the project's public README and repository metadata.

Add this badge to your README

Featured on YunoDB Badge styles & help

Maintain this project? Show that it is featured on YunoDB.

Markdown[![Featured on YunoDB](https://yunodb.com/badge/openaiopenai-openapi.svg)](https://yunodb.com/tools/openaiopenai-openapi?utm_source=github&utm_medium=badge)
HTML<a href="https://yunodb.com/tools/openaiopenai-openapi?utm_source=github&utm_medium=badge"><img src="https://yunodb.com/badge/openaiopenai-openapi.svg" alt="Featured on YunoDB" height="20"></a>