A machine-readable description of the OpenAI REST API, authored in OpenAPI 3.1.
This repository publishes the OpenAPI specification for the OpenAI API. The spec describes the API's endpoints, authentication, parameters, and request and response schemas.
Use it to generate typed clients, build API explorers, configure testing tools, or work with the OpenAI API in any OpenAPI-compatible workflow.
Note
Looking for human-readable documentation, guides, and examples? Visit the OpenAI API docs.
Browse openapi.yaml directly, or download the latest version:
curl -L https://raw.githubusercontent.com/openai/openai-openapi/master/openapi.yaml \
-o openai-openapi.yamlThe document uses OpenAPI 3.1 and can be imported into tools that support the OpenAPI ecosystem.
OpenAI publishes the following official SDKs generated from this specification:
| Language or platform | Repository |
|---|---|
| Python | openai-python |
| JavaScript / TypeScript | openai-node |
| .NET | openai-dotnet |
| Go | openai-go |
| Java | openai-java |
| Ruby | openai-ruby |
Found an incorrect schema, a missing field, or another problem with the specification? Search the existing issues and, if it has not already been reported, open a new issue.
When reporting a problem, include the affected endpoint or schema and a minimal example when possible. The OpenAI team will make a best-effort attempt to triage and resolve spec issues.
For immediate help with the OpenAI API, contact OpenAI Support.
This project is licensed under the MIT License.