Quickstart

Create an API key

Sign in to the dashboard, open Keys, choose Create key and give it a name, for example "report script". The full key is shown only once, so store it somewhere safe right away. Keys start with hvd_.

Install the library

No separate library is needed. The official OpenAI library works.

pip install openai

Send your first request

Only two things differ from the usual code: the base URL and the key. The rest is what you already know.

import osfrom openai import OpenAI client = OpenAI(    base_url="https://<HOVEYDAI_BASE_URL>/v1",    api_key=os.environ["HOVEYDAI_API_KEY"],) resp = client.chat.completions.create(    model="MODEL_ID",    messages=[{"role": "user", "content": "Hello! Introduce yourself in one sentence."}],)print(resp.choices[0].message.content)

Replace MODEL_ID with the id of one of the models; the list is in Models and on models and prices. If you see an answer in the output, everything works.

Stream the answer

To show the answer as it is generated, add stream=True and read the chunks one by one.

stream = client.chat.completions.create(    model="MODEL_ID",    messages=[{"role": "user", "content": "Write a two-line poem."}],    stream=True,)for chunk in stream:    print(chunk.choices[0].delta.content or "", end="")

If you get an error

Three common errors on the very first call:

The full list of errors is on the Errors page.

Next

• Authentication: keeping the key safe and one key per app.
• Streaming: reading chunks in the browser and on the server.
• Endpoint reference: every parameter and response.