Welcome to openaiapi’s documentation!#

A light wrapper around the OpenAI API using apiron.

Installation#

$ python -m pip install openaiapi

Usage#

First, make an OPENAI_API_KEY environment variable available whose value is your OpenAI API key. Once you have an API key in place, you can use the OpenAI class to generate content:

>>> from openaiapi import OpenAI
>>> OpenAI.completions(json={"model": "text-davinci-003", "prompt": "What is your quest?"})
{..., 'choices': [{'text': '\n\nMy quest is to find my purpose and fulfill it.', ...}], ...}}

See the OpenAI documentation for the accepted/required parameters to each endpoint.

Indices and tables#