Overview · Upfyn Docs

There is no Upfyn SDK package, and that is on purpose. The API speaks the OpenAI dialect, so the official openai client works — a widely used, well-tested library rather than one we would maintain in our spare time.

Install#

1pip install openai

Point it at Upfyn#

Two settings: the base URL and your key.

1from openai import OpenAI
2 
3client = OpenAI(
4    base_url="https://ai.upfyn.com/v1",
5    api_key=os.environ["UPFYN_API_KEY"],
6)

What works#

SDK method	Supported
`chat.completions.create`	Yes — streaming and non-streaming, tools, structured outputs.
`models.list`	Yes.
`files.*`	Yes — create, list, retrieve, content, delete.
`images.generate`	Yes.
`images.edit`	Yes.
`audio.speech.create`	Yes.
`audio.transcriptions.create`	Yes.
`responses.*`	Yes.

What is not there

embeddings, moderations, batches, legacy completions, fine_tuning, assistants and vector_stores do not exist. Calling any of them returns a 404.

Sending Upfyn-only fields#

session_id, persist_session, chat_ref and upfyn_tag are not in the OpenAI schema, so a typed client will not let you pass them directly. Use the escape hatch.

Python

1client.chat.completions.create(
2    model="upfyn-yuva",
3    messages=messages,
4    extra_body={"persist_session": True, "upfyn_tag": "billing-bot"},
5)

Where to go next

Python and TypeScript have full worked examples; OpenAI compatibility lists every difference that could surprise you.