Go to file
2024-08-14 11:20:03 -04:00
.github Update authors.yaml and regsitry.yaml url value in pull request template. (#865) 2023-11-27 13:43:20 -08:00
articles Remove Guardrails.ai from related_resources.md because it returns 404 (#1256) 2024-07-07 12:15:33 -07:00
examples Gcp Function Middleware (#1372) 2024-08-13 13:05:44 -04:00
images Gcp Function Middleware (#1372) 2024-08-13 13:05:44 -04:00
.gitignore .gitignore symlinks to lib64 (#1162) 2024-04-28 00:42:07 -07:00
authors.yaml Remove empty website from authors.yaml (#1376) 2024-08-14 11:20:03 -04:00
CONTRIBUTING.md Add conciseness metric to rubric. (#925) 2023-12-19 09:08:18 -08:00
LICENSE Create LICENSE (#136) 2023-02-15 15:20:06 -08:00
README.md Instructions for OPENAI_API_KEY as env var and in IDEs (#1042) 2024-03-28 14:14:24 -07:00
registry.yaml Gcp Function Middleware (#1372) 2024-08-13 13:05:44 -04:00

OpenAI Cookbook Logo

Navigate at cookbook.openai.com

Example code and guides for accomplishing common tasks with the OpenAI API. To run these examples, you'll need an OpenAI account and associated API key (create a free account here). Set an environment variable called OPENAI_API_KEY with your API key. Alternatively, in most IDEs such as Visual Studio Code, you can create an .env file at the root of your repo containing OPENAI_API_KEY=<your API key>, which will be picked up by the notebooks.

Most code examples are written in Python, though the concepts can be applied in any language.

For other useful tools, guides and courses, check out these related resources from around the web.

Contributing

The OpenAI Cookbook is a community-driven resource. Whether you're submitting an idea, fixing a typo, adding a new guide, or improving an existing one, your contributions are greatly appreciated!

Before contributing, read through the existing issues and pull requests to see if someone else is already working on something similar. That way you can avoid duplicating efforts.

If there are examples or guides you'd like to see, feel free to suggest them on the issues page.

If you'd like to contribute new content, make sure to read through our contribution guidelines. We welcome high-quality submissions of new examples and guides, as long as they meet our criteria and fit within the scope of the cookbook.

The contents of this repo are automatically rendered into cookbook.openai.com based on registry.yaml.

Open in GitHub Codespaces